Autonomous and goal-seeking coding agents
Spellbound is a Visual Studio Code extension that leverages the power of the OpenAI API to create an intelligent coding assistant. With Spellbound, you can harness the capabilities of cutting-edge AI to improve your coding experience and productivity.
- Install the Spellbound VS Code extension from the marketplace.
- Obtain an API key for the OpenAI API and configure it in your VS Code settings.
- Obtain a Pinecone API key, create a Pinecone index, and configure it in your VS Code settings.
To use Spellbound, simply interact with your codebase as usual. Whenever you need help, type your request in the Spellbound dialog. Spellbound will use the OpenAI API to help you generate code, troubleshoot, and offer suggestions.
Spellbound uses a "thought/action" control loop to create an autonomous coding agent, as described in the ReAct paper. The agent is able to take actions based on its current thoughts, and its future thoughts are influenced by the results of its actions.
| Parameter | Description | Default | Scope |
|---|---|---|---|
| spellbound.model | Select the AI model used by the Spellbound extension | gpt-4 | |
| spellbound.openai_api_key | Enter your OpenAI API key here, used for inference. | machine | |
| spellbound.pinecone_api_key | Enter your Pinecone API key here, used for search. | machine | |
| spellbound.pinecone_index | Enter your Pinecone index name here, used for search | machine | |
| spellbound.pinecone_environment | Enter your Pinecone environment here, used for search | machine |
To configure the extension settings, open the Settings editor in Visual Studio Code by clicking on the gear icon in the lower left corner and selecting "Settings" from the menu. In the search bar, type "Spellbound" to filter the settings related to the extension. You can then enter your API keys and select the preferred model from the available options.
Environment variables OPENAI_API_KEY and PINECONE_API_KEY will be used in place of the settings if they are set.
The following tools are available for use in Spellbound. The underlying AI model uses tools to solve open-ended tasks.
| Tool | Description |
|---|---|
| cat {path} | Read the content of a file at the given path. |
| ls {path, recursive?} | List files and folders at the given path. |
| search {description} | Search for a file or relevant information by description, via vector embedding search. |
| write {path, contents} | Write (or overwrite) the given contents into the specified file. |
| replace {path, old, new} | Replace all occurrences of old with new in the specified file. |
| ask {question} | Ask a question to the user. |
| npm {script} | Run an npm script (e.g., npm run [script]). |
| done {output?} | Indicate that you are done with the task. |
- Code generation based on natural language input
- Troubleshooting and bug fixing assistance
- Documentation writing and code critique
- Autonomous and goal-seeking coding agents
- Integration with your existing VS Code workflow
To set up the local development environment for the Spellbound extension, see the LOCAL_SETUP.md file.
Spellbound is released under the MIT License. See the LICENSE file for the full license text.
In a world of magic and wonder, Where codes take form as lightning and thunder, A spellbound whisper echoes in the night, As programmers harness the AI's might.
Lines of syntax blend and intertwine, Raising structures with power divine, The keystrokes dance, a graceful ballet, As Spellbound weaves its enchanted array.
Moments of thought guide an intricate plan, As the codebase expands, its reach it will span, The AI and humans work side by side, In the realm of Spellbound, their brilliance will collide.
From simple beginnings to a grand design, Spellbound empowers, transcending the line, A masterpiece found by the ones who dare, To embrace the magic, this bond that we share.
╭━━━╮╱╱╱╱╱╱╱╱╭╮╱╭╮╱╭╮╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╭╮
┃╭━╮┃╱╱╱╱╱╱╱╱┃┃╱┃┃╱┃┃╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱╱┃┃
┃╰━━╮╭━━╮╭━━╮┃┃╱┃┃╱┃╰━╮╭━━╮╭╮╭╮╭━╮╱╭━╯┃
╰━━╮┃┃╭╮┃┃┃━┫┃┃╱┃┃╱┃╭╮┃┃╭╮┃┃┃┃┃┃╭╮╮┃╭╮┃
┃╰━╯┃┃╰╯┃┃┃━┫┃╰╮┃╰╮┃╰╯┃┃╰╯┃┃╰╯┃┃┃┃┃┃╰╯┃
╰━━━╯┃╭━╯╰━━╯╰━╯╰━╯╰━━╯╰━━╯╰━━╯╰╯╰╯╰━━╯
╱╱╱╱╱┃┃
╱╱╱╱╱╰╯