@aiiware/aii 0.2.1 → 0.2.3

package/README.md

@@ -1,11 +1,9 @@
 # @aiiware/aii
 
-**AI-powered CLI assistant** that brings intelligent AI capabilities directly to your terminal.
+**AI-powered CLI assistant** with autonomous tool execution. An intelligent agent that can read, write, search, and execute commands in your terminal.
 
 ## Installation
 
-Install globally to use the `aii` command anywhere:
-
 ```bash
 npm install -g @aiiware/aii
 ```
@@ -18,105 +16,109 @@ npm install -g @aiiware/aii
 ## Quick Start
 
 ```bash
-# First run - auto-initializes configuration
-aii "explain what git rebase does"
+# Start interactive agent mode
+aii
+
+# Or run a single query
+aii "explain what this project does"
 
 # Pipe content for processing
 cat error.log | aii "summarize the errors"
 
-# Interactive chat mode
-aii chat
-
-# Clean output (just the result)
-aii "translate hello to spanish" --clean
-
-# Use a specific model
-aii "complex analysis" --model gpt-4o
+# Auto-approve tool execution
+aii --auto
 ```
 
-## Commands
+## Agent Mode (Default)
+
+Aii runs as an intelligent agent that can autonomously execute tools to complete tasks:
 
-### AI Query (default)
 ```bash
-aii "your question"
-aii "your question" --clean        # Just the result
-aii "your question" --standard     # Result + metrics (default)
-aii "your question" --thinking     # Full reasoning
+aii                    # Start interactive session
+aii "your task"        # Run single task and exit
 ```
 
-### Interactive Chat
-
-```bash
-aii chat                           # Start interactive chat session
-
-# In chat mode:
-/help          # Show available commands
-/clear         # Clear conversation and start fresh
-/history       # Show conversation history
-/stats         # Show session statistics
-/exit          # Exit chat mode
+### Available Tools
+
+| Tool          | Description                    |
+|---------------|--------------------------------|
+| **Read**      | Read file contents             |
+| **Write**     | Create or overwrite files      |
+| **Edit**      | Make targeted edits to files   |
+| **Glob**      | Find files by pattern          |
+| **Grep**      | Search code with regex         |
+| **Bash**      | Execute shell commands         |
+| **WebSearch** | Search the web                 |
+
+### Interactive Commands
+
+In agent mode, use these commands:
+
+```text
+/help              Show available commands
+/clear             Clear conversation history
+/history           Show conversation history
+/stats             Show session statistics (tokens, cost)
+/model <model>     Switch LLM model
+/provider <name>   Switch LLM provider
+/exit              Exit the session
 ```
 
-### Prompts (Templates)
+### Keyboard Shortcuts
+
+| Key        | Action                     |
+|------------|----------------------------|
+| `Enter`    | Submit input               |
+| `Esc`      | Cancel current request     |
+| `Ctrl+C`   | Exit immediately           |
+| `Up/Down`  | Navigate input history     |
+| `Tab`      | Autocomplete commands      |
+
+## Output Modes
 
 ```bash
-aii prompt list                    # List available prompts
-aii prompt show <name>             # Show prompt details
-aii prompt use <name> [--var value]  # Use a prompt template
+aii "query" --clean        # Just the result
+aii "query" --standard     # Result + metrics (default)
+aii "query" --thinking     # Full reasoning chain
 ```
 
-### Configuration
+## Prompt Templates
+
+Use pre-built templates for common tasks:
+
 ```bash
-aii config show                    # Show current configuration
-aii config validate                # Validate configuration
-aii config set <key> <value>       # Set a configuration value
-aii config model <model>           # Change LLM model
-aii config provider <provider>     # Change LLM provider
+aii prompt list                       # List available prompts
+aii prompt show <name>                # Show prompt details
+aii prompt use <name> --var value     # Use a prompt template
 ```
 
-### System
+## Configuration
+
 ```bash
-aii doctor                         # System health check
-aii --help                         # Show help
-aii --version                      # Show version
+aii config show                # Show current configuration
+aii config validate            # Validate configuration
+aii config set <key> <value>   # Set a configuration value
+aii config model <model>       # Change LLM model
+aii config provider <provider> # Change LLM provider
 ```
 
-## Options
-
-| Option | Description |
-|--------|-------------|
-| `--clean` | Clean output mode (just the result) |
-| `--standard` | Standard output mode (result + metrics) |
-| `--thinking` | Thinking mode (full reasoning) |
-| `--model <model>` | Override LLM model |
-| `--host <host:port>` | API server host |
-| `-y, --yes` | Auto-confirm shell commands |
-| `--offline` | Offline mode (no web/MCP) |
-| `--no-colors` | Disable colored output |
-| `--no-emojis` | Disable emoji icons |
-| `--no-streaming` | Disable streaming output |
-
-## Configuration
+### Config Files
 
 Configuration is stored in `~/.aii/`:
-- `config.yaml` - Main configuration
-- `secrets.yaml` - API keys
 
-### Example config.yaml
+**config.yaml** - Main configuration:
 
 ```yaml
 llm:
-  provider: deepseek
-  model: deepseek-chat
+  provider: anthropic
+  model: claude-sonnet-4
   temperature: 0.7
 
 api:
   url: http://localhost:26169
 ```
 
-### API Keys
-
-Store your LLM provider API keys in `~/.aii/secrets.yaml`:
+**secrets.yaml** - API keys:
 
 ```yaml
 anthropic_api_key: sk-ant-...
@@ -124,19 +126,40 @@ openai_api_key: sk-...
 deepseek_api_key: sk-...
 ```
 
-Or set via environment variables:
-- `ANTHROPIC_API_KEY`
-- `OPENAI_API_KEY`
-- `DEEPSEEK_API_KEY`
+Or use environment variables: `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, `DEEPSEEK_API_KEY`
+
+## CLI Options
+
+| Option               | Description                      |
+|----------------------|----------------------------------|
+| `--auto`             | Auto-approve all tool executions |
+| `--clean`            | Clean output mode                |
+| `--standard`         | Standard output mode (default)   |
+| `--thinking`         | Show full reasoning              |
+| `--model <model>`    | Override LLM model               |
+| `--host <host:port>` | API server host                  |
+| `--no-streaming`     | Disable streaming output         |
+| `--quiet`            | Minimal output                   |
+| `--verbose`          | Show detailed stats              |
+
+## System Commands
+
+```bash
+aii doctor         # System health check
+aii --help         # Show help
+aii --version      # Show version
+```
 
 ## Features
 
+- **Autonomous Agent**: Executes multi-step tasks with tool use
 - **Real-time Streaming**: Token-by-token response display
-- **Interactive Chat**: Multi-turn conversations with context
+- **Interactive Mode**: Multi-turn conversations with full context
+- **Tool Execution**: Read, write, search, and run commands
+- **Multiple Providers**: Claude, GPT, Gemini, DeepSeek
 - **Prompt Templates**: Pre-built templates for common tasks
-- **Multiple LLM Providers**: Claude, GPT, Gemini, DeepSeek, and more
-- **Pipe Support**: Process piped content with AI
-- **Output Modes**: Clean, standard, or thinking mode
+- **Input History**: Navigate previous inputs with arrow keys
+- **Cancellation**: Press Esc to cancel any request
 
 ## Links
 
@@ -145,4 +168,4 @@ Or set via environment variables:
 
 ## License
 
-Proprietary - Copyright 2025-present AiiWare.com. All Rights Reserved.
+Proprietary - Copyright 2025-present AiiWare.com. All Rights Reserved.