deputy

Crates.iodeputy
lib.rsdeputy
version0.2.12
created_at2025-07-04 09:10:23.641608+00
updated_at2025-08-03 13:03:23.37415+00
descriptionAn experimental terminal-based AI coding assistant that integrates directly with your filesystem and shell. Deputy leverages agentic LLM systems to read code, manipulate files, execute shell commands, and navigate projects. It provides a modular, permissioned workflow for safe, contextual, and automated developer assistance, supporting both OpenAI and Anthropic backends.
homepage
repositoryhttps://github.com/hgrsd/deputy
max_upload_size
id1737666
size1,330,428
Daniƫl (hgrsd)

documentation

README

Deputy

A terminal-based AI coding assistant that actually works with your files and shell.

What it does

Deputy gives you an AI assistant that can:

  • Read and write files in your project
  • Run shell commands
  • Navigate your codebase intelligently
  • Remember what you've approved it to do

No copying and pasting code snippets. No switching between terminal and browser. Just tell it what you want and it gets on with it.

Installation

cargo install deputy

Set your API key:

export ANTHROPIC_API_KEY=your_key_here
# or
export OPENAI_API_KEY=your_key_here

Usage

cd your-project
deputy

That's it. Deputy will scan your project and you can start chatting.

Options

deputy --provider openai --model gpt-4o    # Use OpenAI instead
deputy --yolo                              # Skip permission prompts
deputy --base-url http://localhost:8080/v1 # Custom API endpoint
deputy --config ./my-config.md             # Use custom configuration file

Permissions

Deputy asks before doing potentially destructive things. You can:

  • Approve once
  • Remember your choice for similar operations
  • Use --yolo mode to skip prompts entirely

Configuration

You can specify a custom configuration file using the --config option:

deputy --config ./path/to/my-config.md

When using --config, Deputy will read ONLY that file and ignore the default search locations.

If no custom config is specified, Deputy loads configuration files in priority order (first found wins):

  1. DEPUTY.md in your project root
  2. ~/.deputy/DEPUTY.md for global config
  3. AGENTS.md in your project root
  4. CLAUDE.md in your project root
  5. ~/.claude/CLAUDE.md for global config

These files contain instructions that Deputy will follow during your session.

Contributing

Issues and PRs welcome.

License

MIT

Commit count: 0

cargo fmt