@compilr-dev/cli
v0.5.0
Published
AI-powered coding assistant CLI using @compilr-dev/agents
Maintainers
Readme
@compilr-dev/cli
\|/
╭══════════╮ ___ ___ _ __ ___ _ __ (_) |_ __
║' ▐▌ ▐▌ │ / __|/ _ \| '_ ` _ \| '_ \| | | '__|
║ │ | (__| (_) | | | | | | |_) | | | |
╰─═──────═─╯ \___|\___/|_| |_| |_| .__/|_|_|_|
\________\ | | .dev
|_| CLIAI-powered CLI assistant using @compilr-dev/agents
Overview
An AI coding assistant for the terminal, built with the @compilr-dev/agents library. Supports multiple LLM providers (Claude, OpenAI, Gemini, Ollama) with streaming output, tool execution, and context management.
Features
- Multi-LLM Support - Claude, OpenAI, Gemini, Ollama
- Streaming Output - Real-time response display with cursor positioning
- Tool Execution - File operations, git, code search, project detection
- Context Management - Auto-compaction, LLM summarization, token tracking
- Persistent Footer - Todo list and input prompt always visible
- Input Queueing - Commands queued during agent execution (FIFO)
- Permissions - Interactive approval for dangerous operations
- Esc to Cancel - Immediately abort running agent
Installation
npm install -g @compilr-dev/cliUsage
# Start with default provider (Claude)
compilr
# Use a specific provider
compilr --provider openai --model gpt-4o
compilr --provider gemini --model gemini-1.5-pro
compilr --provider ollama --model llama3.1:8b
# Verbose mode (show tool filtering)
compilr --verboseSlash Commands
| Command | Description |
|---------|-------------|
| /help | Show available commands |
| /exit | Exit the CLI |
| /clear | Clear conversation history |
| /compact | Compress context using LLM summarization |
| /tools | List available tools |
| /tokens | Show token usage |
| /context | Show context statistics |
Requirements
- Node.js 18 or higher
- API key for your chosen provider:
ANTHROPIC_API_KEYfor ClaudeOPENAI_API_KEYfor OpenAIGOOGLE_API_KEYfor Gemini- Ollama running locally (no API key needed)
Development
# Clone the repository
git clone https://github.com/compilr-dev/cli.git
cd cli
# Install dependencies
npm install
# Run in development mode
npm run dev
# Build for production
npm run buildArchitecture
- Runtime: Node.js 18+
- Language: TypeScript
- Agent Framework: @compilr-dev/agents
- Coding Tools: @compilr-dev/agents-coding
- UI: Custom terminal zones (scrolling + persistent footer)
Documentation
Full documentation and tutorials available at compilr.dev:
- Getting Started Guide
- Configuration Reference
- Tool Documentation
- Best Practices
Contributing
Contributions are welcome! Please see CONTRIBUTING.md for guidelines.
License
MIT
Links
- compilr.dev - Main website & documentation
- @compilr-dev/agents - Agent library
- @compilr-dev/agents-coding - Coding tools
- GitHub - Source code
- Examples - Example projects
[^_^] Built with @compilr-dev/agents