Skip to main content

Your agentic CLI developer.

Project description

Sidekick (Beta)

Sidekick Demo

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

  1. Clone the repository
  2. Install dependencies: pip install . (or pip install -e . for development)

Development

# Install development dependencies
make install

# Run linting
make lint

# Run tests
make test

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sidekick_cli-0.3.1.tar.gz (29.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sidekick_cli-0.3.1-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

Details for the file sidekick_cli-0.3.1.tar.gz.

File metadata

  • Download URL: sidekick_cli-0.3.1.tar.gz
  • Upload date:
  • Size: 29.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sidekick_cli-0.3.1.tar.gz
Algorithm Hash digest
SHA256 86cfee96f0dfa5ed66c3331b7509f45b9be29147d42d26bdbfabc11f468ed0e5
MD5 eb39d755a799691e2664b83314db50d5
BLAKE2b-256 b437d6dd6ebe16ff81702995ad1d99e39aa94a77f9106dc3061a915a03cdd4f7

See more details on using hashes here.

File details

Details for the file sidekick_cli-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: sidekick_cli-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 30.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sidekick_cli-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aca8b8447386b52180bc54dfa9eed95246cb472fbca59f278590c274c16d1085
MD5 7a6196ae30fff27c93fa385b5161fabd
BLAKE2b-256 f20f1829e41b987b5f94998f5aa3017331265440ec23b3456f5a434b84f7255f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page