Skip to main content

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.
  • Use /undo when AI breaks things.
  • 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.
  • Easily switch between models in the same session.
  • Cost and token tracking.
  • Web searching and fetching built-in.
  • Per command or per session confirmation skipping.

Roadmap

  • Tests 😅
  • More LLM providers, including Ollama
  • Plugin system (custom tools and agents)
  • MCP Support

Quick Start

Install Sidekick and Playwright:

pip install sidekick-cli
python -m playwright install

Startup Sidekick and configure 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.

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

For the best web search and fetching results, install Playwright:

python -m playwright install

From Source

  1. Clone the repository
  2. Install dependencies: pip install . (or pip install -e . for development)
  3. Install Playwright: python -m playwright install

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.2.0.tar.gz (20.8 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.2.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sidekick_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 20.8 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.2.0.tar.gz
Algorithm Hash digest
SHA256 c7386b527aaae6e0e78388b1745a083fb6b7afc83e7721e02d485d6f7a2c5580
MD5 609f61d8de309a3570307887f8bd5bb5
BLAKE2b-256 9f2961eb373ce0b7a6dc74eb6e2385ff511ae184660a3a7a122476c5c5853682

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sidekick_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 3.7 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1c0f30219acd9de0cf5c671c886353331f437bd144856b20de914aa71848cfe8
MD5 73f1215d761cca0485a05d35ee14bbef
BLAKE2b-256 484e45be06ed73a5afb50de7c2ffe6fe590a654d17af39db87247dc820e98694

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