Hunter Bown
cc0ac49822
- Fix CI eval step to use `cargo run -p deepseek-tui` instead of bare `cargo run` which fails with multiple binaries - Add --workspace flag to clippy, test, and doc CI steps - Rewrite README: lead with install command, tighten verbiage, consolidate quickstart, drop verbose architecture section
2.4 KiB
2.4 KiB
DeepSeek TUI
npm i -g deepseek-tui
A coding agent for DeepSeek models that runs in your terminal.
Quickstart
npm install -g deepseek-tui
Set your API key:
mkdir -p ~/.deepseek && echo 'api_key = "YOUR_DEEPSEEK_API_KEY"' > ~/.deepseek/config.toml
Then run:
deepseek-tui
Other install methods
# From crates.io (requires Rust 1.85+)
cargo install deepseek-tui --locked
# From source
git clone https://github.com/Hmbown/DeepSeek-TUI.git
cd DeepSeek-TUI
cargo install --path crates/tui --locked
What it does
An agent loop with file editing, shell execution, web search, git operations, task tracking, and MCP server integration. Context-aware memory compaction keeps long sessions on track.
Three modes (Tab to switch):
| Mode | Behavior |
|---|---|
| Plan | Design-first — proposes before acting |
| Agent | Multi-step autonomous tool use |
| YOLO | Full auto-approve, no guardrails |
Usage
deepseek-tui # interactive TUI
deepseek-tui -p "explain this in 2 sentences" # one-shot prompt
deepseek-tui --yolo # YOLO mode
deepseek doctor # check setup
deepseek models # list available models
deepseek serve --http # HTTP/SSE API server
F1 opens help. Esc cancels a running request. Ctrl+K opens command palette.
Configuration
~/.deepseek/config.toml — see config.example.toml for all options.
Key environment overrides: DEEPSEEK_API_KEY, DEEPSEEK_BASE_URL, DEEPSEEK_PROFILE.
Full reference: docs/CONFIGURATION.md.
Docs
docs/ — architecture, modes, MCP integration, runtime API.
Contributing
See CONTRIBUTING.md. Not affiliated with DeepSeek Inc.