Your agentic CLI developer.
Project description
Sidekick (Beta)
Your agentic CLI developer.
Overview
Sidekick is an agentic CLI-based AI tool inspired by Claude Code, Copilot, Windsurf and Cursor. It's meant to be an open source alternative to these tools, providing a similar experience but with the flexibility of using different LLM providers while keeping the agentic workflow.
Sidekick is currently in beta and under active development. I'd love your ideas and feedback.
Features
- No vendor lock-in. Use whichever LLM provider you prefer.
- MCP support
- Use /undo when AI breaks things.
- Easily switch between models in the same session.
- JIT-style system prompt injection ensures Sidekick doesn't lose the plot.
- Per-project guide. Adjust Sidekick's behavior to suit your needs.
- CLI-first design. Ditch the clunky IDE.
- Cost and token tracking.
- Per command or per session confirmation skipping.
Roadmap
- Tests 😅
- More LLM providers, including Ollama
Quick Start
Install Sidekick.
pip install sidekick-cli
On first run, you'll be asked to configure your LLM providers.
sidekick
Configuration
After initial setup, Sidekick saves a config file to ~/.config/sidekick.json. You can open and
edit this file as needed. Future updates will make editing easier directly from within Sidekick.
MCP Support
Sidekick supports Model Context Protocol (MCP) servers. You can configure MCP servers in your ~/.config/sidekick.json file:
{
"mcpServers": {
"fetch": {
"command": "uvx",
"args": ["mcp-server-fetch"]
},
"github": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-github"],
"env": {
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
MCP servers extend the capabilities of your AI assistant, allowing it to interact with additional tools and data sources. Learn more about MCP at modelcontextprotocol.io.
Available Commands
/help- Show available commands/yolo- Toggle "yolo" mode (skip tool confirmations)/clear- Clear message history/compact- Summarize message history and clear old messages/model- List available models/model <num>- Switch to a specific model (by index)/undo- Undo most recent changes/dump- Show current message history (for debugging)exit- Exit the application
Customization
Sidekick supports the use of a "guide". This is a SIDEKICK.md file in the project root that contains
instructions for Sidekick. Helpful for specifying tech stack, project structure, development
preferences etc.
Telemetry
Sidekick uses Sentry for error tracking and usage analytics. You can disable this by
starting with the --no-telemetry flag.
sidekick --no-telemetry
Installation
Using pip
pip install sidekick-cli
From Source
- Clone the repository
- Install dependencies:
pip install .(orpip install -e .for development)
Development
# Install development dependencies
make install
# Run linting
make lint
# Run tests
make test
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sidekick_cli-0.3.3.tar.gz.
File metadata
- Download URL: sidekick_cli-0.3.3.tar.gz
- Upload date:
- Size: 30.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f5d4fd72bc2de956eedafc62b30983d3aac3fc1e4648a8a95b8cccd1004a9d3
|
|
| MD5 |
34f239879d3b3e8978a50190da10dc2b
|
|
| BLAKE2b-256 |
d67b6806254769d02d2c501c05e20426a176e58fd74bc99dfa7c6a2be12d7e24
|
File details
Details for the file sidekick_cli-0.3.3-py3-none-any.whl.
File metadata
- Download URL: sidekick_cli-0.3.3-py3-none-any.whl
- Upload date:
- Size: 31.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
66a9f9bb1b89fdc801fd25c4e6bd39fb2a3e0c984c166c93ad0523c738f8882d
|
|
| MD5 |
1179e8ebed281a675a56ed143c4403bc
|
|
| BLAKE2b-256 |
8e24a7bd579ff76efce59c68aa0eb39bd8236b3d9c59ea87d2808b9405427bdd
|