beckon — Distinct sounds signaling your AI agent's…

Pitch

Description

Comments

About this project

Beckon offers a unique auditory experience for developers by providing distinct sounds that notify users of their AI coding agent's status. No need to monitor the terminal constantly—beckon plays different sounds to indicate whether the task is complete, a decision is needed, or a failure has occurred, allowing for a more seamless coding experience.

beckon is an innovative tool designed to enhance the interaction with AI coding agents by providing distinct auditory cues. These sounds enable users to stay informed about the status of their coding tasks without continuously monitoring the terminal.

Key Features

beckon integrates seamlessly with your agent's lifecycle hooks, assigning specific sounds to various states of operation:

Sound	Meaning	Action
rising chime	Indicates completion of a turn	Check the output
insistent sting	Signals that a decision is needed	Provide the necessary input
falling tone	Indicates a failure	Review the error message
slow pulse	Implies the process is rate-limited	Wait for completion

Unlike generic notifications, beckon's distinct sounds convey the urgency and nature of the event, guiding users on the appropriate next steps.

Installation and Configuration

Users can easily install beckon using Cargo and configure it to their specific needs. The setup process includes:

cargo install beckon-cli   # Install beckon
beckon init                # Bind the hooks
beckon test                # Test the installed sounds

The configuration process ensures that any changes are safe, preserving original settings while allowing customization.

Supported Platforms

beckon is compatible with multiple operating systems, including:

Linux x86-64: Fully supported
macOS: CI tested, audio verification pending
Windows: CI tested, audio verification pending

Commands and Functionality

A variety of commands are available to interact with beckon:

beckon test                     # Play all sounds in the active pack
beckon packs                    # List available sound packs
beckon use cipher               # Switch to a specific sound pack
beckon mute 30m                 # Mute the sounds temporarily
beckon doctor                   # Diagnose any issues with sound playback
beckon config set volume 0.4    # Adjust the sound volume
beckon uninstall                 # Remove beckon configuration

Custom Sound Packs

Users can create personalized sound packs that are lightweight and easily auditable. Each sound recipe is a TOML file, ensuring that sound definitions are original and can be reviewed efficiently. Default sound packs include:

aurora: Soft sounds reminiscent of a calm starship computer.
cipher: Sharp and clear alerts designed for stealthy environments.
unit-7: Mechanical sounds perfect for lab settings.

To create or modify sound packs, simply place a pack.toml in the appropriate directory, which will override built-in sounds of the same name.

Conclusion

beckon transforms the way developers interact with AI coding agents, minimizing the attention required on the terminal by providing meaningful audio feedback. With its customizable features and user-friendly design, beckon is a practical tool for anyone looking to enhance their coding efficiency.