- Add comprehensive installation and quick start guide - Document all CLI commands and options - Add TUI keybindings reference - Include full configuration documentation - Document agent mode usage - Update project structure for Rust crates - Remove outdated TypeScript references 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
5.1 KiB
5.1 KiB
Miyabi CLI
A powerful terminal-based AI assistant with TUI (Terminal User Interface) built in Rust.
Features
- Interactive TUI - Beautiful terminal interface with markdown rendering
- Chat Mode - Conversational AI assistant
- Agent Mode - Autonomous task execution with tool approval
- Session Management - Persist and resume conversations
- Configurable - TOML-based configuration
- Extended Thinking - Support for Claude 4.5+ extended thinking
Installation
Prerequisites
- Rust 1.70+
- Anthropic API key
Build from Source
git clone https://github.com/ShunsukeHayashi/miyabi-cli-standalone.git
cd miyabi-cli-standalone
cargo build --release
Binary will be at target/release/miyabi.
Quick Start
1. Generate Config
./target/release/miyabi init
This creates ~/.miyabi/config.toml.
2. Set API Key
Edit ~/.miyabi/config.toml:
[api]
api_key = "sk-ant-..."
Or use environment variable:
export ANTHROPIC_API_KEY="sk-ant-..."
3. Launch TUI
./target/release/miyabi tui
# or simply
./target/release/miyabi
Usage
CLI Commands
miyabi # Start TUI (default)
miyabi tui # Start TUI explicitly
miyabi status # Show status
miyabi init # Generate default config
miyabi sessions # List sessions
miyabi sessions -d <id> # Delete session
miyabi sessions -e <id> # Export session to JSON
miyabi version # Show version info
miyabi agent <prompt> # Run autonomous agent
CLI Options
miyabi --model claude-sonnet-4-5-20250929 # Override model
miyabi --max-tokens 16384 # Override max tokens
miyabi --thinking # Enable extended thinking
miyabi --config /path/to/config.toml # Custom config
miyabi --session <id> # Resume session
TUI Keybindings
| Key | Action |
|---|---|
Enter |
Send message |
Ctrl+P |
Command palette |
F1 |
Help |
Esc |
Close overlay / Cancel |
Ctrl+C |
Quit |
j/k |
Scroll down/up |
Page Up/Down |
Page scroll |
Configuration
Config file: ~/.miyabi/config.toml
[api]
api_key = "sk-ant-..." # Anthropic API key
model = "claude-sonnet-4-5-20250929" # Model to use
max_tokens = 8192 # Max response tokens
thinking = false # Extended thinking
system_prompt = "You are a helpful assistant" # System prompt
timeout_secs = 120 # Request timeout
max_retries = 3 # Retry attempts
[ui]
show_sidebar = false # Show sidebar
show_status_bar = true # Show status bar
show_breadcrumb = true # Show breadcrumb
theme = "tokyo-night" # Color theme
vim_mode = false # Vim keybindings
show_line_numbers = true # Line numbers in code
[session]
auto_save = true # Auto-save sessions
auto_save_interval = 30 # Save interval (seconds)
max_sessions = 100 # Max stored sessions
[tools]
enable_bash = true # Enable bash tool
enable_file_tools = true # Enable file read/write
enable_search_tools = true # Enable glob/grep
auto_approve_low_risk = false # Auto-approve safe tools
bash_timeout = 120 # Bash command timeout
Environment Variables
Override config with environment variables:
ANTHROPIC_API_KEY=... # API key
MIYABI_MODEL=... # Model name
MIYABI_MAX_TOKENS=... # Max tokens
MIYABI_THINKING=true # Enable thinking
Agent Mode
Run autonomous tasks with tool execution:
# Basic usage
miyabi agent "Create a hello world Python script"
# With options
miyabi agent "Refactor the utils module" \
--max-iterations 20 \
--auto-approve \
--system "You are an expert Rust developer"
Agent mode features:
- Autonomous tool execution (bash, file operations, search)
- Approval workflow for risky operations
- Iteration limits for safety
- JSON output format option
Project Structure
miyabi-cli-standalone/
├── crates/
│ ├── miyabi-cli/ # CLI entry point
│ ├── miyabi-core/ # Core library
│ │ ├── agent/ # Agent system
│ │ ├── config.rs # Configuration
│ │ ├── session.rs # Session management
│ │ └── ...
│ └── miyabi-tui/ # TUI implementation
│ ├── app.rs # Main application
│ ├── views.rs # UI views
│ └── ...
├── .miyabi/ # Local config
├── Cargo.toml # Workspace config
└── README.md
Development
Build
cargo build # Debug build
cargo build --release # Release build
Test
cargo test --all # Run all tests
Lint
cargo clippy --all-targets -- -D warnings
cargo fmt --all --check
Models
Supported models:
claude-sonnet-4-5-20250929(default)claude-haiku-4-5-20251001claude-sonnet-4-20250514
License
MIT
Built with Rust, Ratatui, and Claude API.