JSPM

  • Created
  • Published
  • Downloads 282
  • Score
    100M100P100Q102638F
  • License SEE LICENSE IN LICENSE

๐Ÿชผ AI-powered CLI assistant for terminal productivity

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aiiware/aii) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Aii

    Aii โ€” AI Agent for Your Terminal

    An autonomous AI assistant that lives in your terminal. Ask it anything โ€” it reads your files, runs commands, searches the web, and writes code. No copy-pasting, no tab-switching. Just describe what you want.

    npm: @aiiware/aii ยท Version: 0.13.7 ยท Node.js: >= 18


    Quick Start

    # 1. Install
    npm install -g @aiiware/aii
    
    # 2. Go
    aii -D hi there!

    On first run, Aii auto-launches a setup wizard to configure your AI provider, model, and API key. After setup completes, your command executes automatically.

    Already know your provider? You can also configure directly: aii config apikey <provider> <key>

    Requirements: Node.js 18+ and Docker


    What Can You Do With It?

    Talk to it

    aii explain how this codebase is structured

    Pipe anything in

    git diff | aii review these changes for bugs
    cat error.log | aii what went wrong?
    echo "Hello world" | aii translate to Japanese

    Let it commit for you

    aii run git commit -y

    It reads your staged changes, writes a Conventional Commits message, and commits โ€” one command.

    Start an interactive session

    aii

    You get a rich terminal UI with streaming responses, syntax highlighting, diff previews, and autocomplete for slash commands.

    Switch models on the fly

    aii --model ollama/llama3.1:8b write a bash one-liner to find large files
    aii --model deepseek/deepseek-chat explain this regex
    aii --model openai/gpt-4.1 refactor this function

    Or during a session: /model anthropic:claude-sonnet-4

    Run it autonomously

    aii loop "fix all failing tests" --verify "npm test" --budget 0.50

    The agent loops with fresh context each iteration, stopping when your verification command passes, the budget is hit, or you press Esc. Steer it mid-run with /pause, /resume, /stop, /stats, /note, and /now. Feedback appears in a dedicated toast zone โ€” not mixed into agent output.


    Providers

    8 LLM providers, switch anytime with aii config provider <name>:

    Provider What You Get
    Anthropic Claude Sonnet 4, Opus 4, Haiku 4.5
    OpenAI GPT-5.2, GPT-4o, GPT-4.1
    Google Gemini 3-pro, 2.5-pro, 2.5-flash
    DeepSeek deepseek-chat, deepseek-reasoner
    Moonshot Kimi K2 Thinking, Vision
    Z.ai GLM-4.7, GLM-4.6V, GLM-4.5
    Ollama Any local model โ€” free, private, offline
    OpenRouter 300+ models through one API key

    Ollama users: aii config provider ollama auto-discovers your installed models and lets you pick from an interactive menu.


    Tools

    The agent autonomously picks from 10 built-in tools:

    Tool What It Does
    Read Read any file
    Write Create or overwrite files
    Edit Surgical find-and-replace edits
    Glob Find files by pattern
    Grep Search file contents (regex)
    Bash Run shell commands
    WebSearch Search the web
    WebFetch Fetch and parse web pages
    Task Delegate to parallel subagents
    Skill Invoke extensible skill packages

    You control what the agent can do. By default, it asks before running commands or writing files. Use --auto to skip confirmations.


    Slash Commands

    During interactive sessions, type / to see all commands. Highlights:

    Command What It Does
    /help Show all commands
    /model [name] View or switch model
    /provider [name] View or switch provider
    /soul [name] View or switch soul (thinker, doer, coder)
    /theme [name] View or switch color theme
    /auto Toggle auto-approve mode
    /plan Toggle plan mode (read-only)
    /diff See all file changes this session
    /undo Revert the last file change
    /stats Session stats โ€” tokens, cost, duration
    /context Context window usage; /context clear to summarize
    /aii [question] Ask about Aii features, commands, and usage
    /commit AI-powered git commit
    /review-pr AI-powered PR review
    /worktree create Isolated workspace for experiments
    /mcp install Add MCP server from catalog
    /mcp reconnect Reconnect failed MCP servers
    /skills List and manage skill packages
    /sessions Browse and resume past sessions
    /exit End session with summary

    Keyboard Shortcuts

    Key Action
    Enter Submit input
    Esc Cancel current request
    Ctrl+C Exit immediately
    Ctrl+D Graceful exit with session summary
    Ctrl+L Clear conversation
    Ctrl+U Clear type-ahead queue / input line
    Up/Down Navigate input history
    Tab Autocomplete commands

    Key Features

    Subagents

    The agent delegates complex tasks to specialized subagents running in parallel:

    Agent Purpose Tools
    Explore Fast codebase search and analysis Read-only
    Plan Architecture and implementation design Read-only
    Review Code quality analysis Read-only
    Code Full implementation All tools

    Define custom agents in .aii/agents/<name>.md with YAML frontmatter for custom system prompts, model tiers, and tool access.

    Git Worktrees

    Work on multiple features in parallel without stashing:

    aii worktree create auth-refactor    # Create isolated workspace + branch
    aii worktree list                    # See all worktrees
    aii worktree merge auth-refactor     # Merge back
    aii worktree clean                   # Remove all clean worktrees

    Or use /worktree slash commands during a session.

    Autonomous Loops

    Run the agent in a continuous loop with guardrails:

    aii loop "fix all TypeScript errors"
    aii loop --max 10 --verify "npm test" "add missing tests"
    aii loop --budget 1.00 --duration 8h "refactor the auth module"

    Exit conditions: --max N, --budget $N, --verify "cmd", --promise "text", --duration <time>, --input-tokens N, --output-tokens N

    Mid-loop controls โ€” type while the loop runs:

    Command What It Does
    /pause [duration] Pause after the current tool call (e.g., /pause 5m, /pause 2h)
    /resume Resume a paused loop
    /stop Finish current iteration, then exit cleanly
    /stats Live view of tokens, cost, iterations, elapsed time
    /note <text> Queue guidance โ€” consumed one per iteration with visual feedback
    /now <text> Inject an urgent note immediately โ€” the agent sees it at the next tool call boundary

    Pause takes effect between tool calls โ€” the agent finishes what it's doing, then waits. Timed pauses auto-resume after the duration. The status bar shows pause state with a countdown timer.

    /note vs /now โ€” /note queues guidance for the next iteration. /now delivers it immediately within the current turn, so the agent can pivot without waiting. If the agent has no more tool calls left, /now falls back to the next iteration โ€” your note is never lost.

    The status bar updates in real time with iteration count, token usage, estimated cost, and tool calls โ€” you always know what the loop is doing and what it's costing.

    Telegram Integration

    Run the full agent from Telegram:

    aii telegram pair mybot <bot-token>  # Pair with @BotFather token
    aii telegram start mybot             # Start listening
    aii telegram list                    # Manage bots

    Responses stream live โ€” you see the agent's reply building in real time, just like in the terminal.

    Start a conversation in Telegram, continue it from the CLI โ€” or vice versa.

    Soul System

    Each agent has a personality โ€” called a soul โ€” that shapes how it communicates. Built on SoulSpec v0.4.

    aii soul help                     # See available souls
    aii soul switch doer              # Switch personality

    Or during a session: /soul doer

    Built-in souls:

    Soul Display Name Style
    thinker Aii Thinker ๐Ÿชผ Patient and collaborative โ€” thinks out loud, walks through reasoning (default)
    doer Aii Doer ๐Ÿชผ Direct and efficient โ€” leads with the answer, every sentence earns its place
    coder Aii Coder ๐Ÿชผ Pair-programming partner โ€” reads your codebase, references specific lines

    Your preference persists across sessions and channels.

    Custom souls: Create your own in .aii/soul/ with SOUL.md, STYLE.md, IDENTITY.md, and an optional soul.json manifest. Custom souls introduce themselves as "{Name}, powered by Aii ๐Ÿชผ".

    Theme System

    7 built-in color themes โ€” switch with /theme <name> or aii config set theme <name>:

    classic (default), brand, teal, indigo, forest, amber, grayscale

    Your preference persists across sessions.

    Skills System

    Extensible instruction packages you can install and invoke:

    /skills                                        # List all skills
    /skills install owner/repo/skill-name          # Install from GitHub
    /aii how do loops work?                        # Built-in: self-serve help
    /commit                                        # Built-in: AI git commit
    /review-pr                                     # Built-in: PR review
    /explain this function                         # Built-in: code explainer
    /<custom-skill> [args]                         # Any user-invocable skill

    Install accepts GitHub URLs in any format โ€” repo paths, blob URLs, and bare repo URLs all work.

    Create skills in .aii/skills/<name>/SKILL.md with YAML frontmatter.

    Project Instructions (AGENTS.md)

    Drop an AGENTS.md file in your project root to give the agent project-specific context โ€” coding conventions, architecture notes, preferred patterns. It's loaded automatically.

    /init                   # Auto-generate by analyzing your project
    /memory                 # View loaded instructions

    Also discovers CLAUDE.md, .cursorrules, and .github/copilot-instructions.md.

    Hook System

    Run custom scripts when the agent takes actions. Configure in .aii/hooks.json:

    Events: PreToolUse, PostToolUse, Stop, SubagentStart, SubagentStop

    /hooks                  # View configured hooks
    /hooks reload           # Hot-reload without restart

    MCP Servers

    Extend the agent with Model Context Protocol servers:

    aii mcp catalog                    # Browse available servers
    aii mcp install github             # One-command install
    aii mcp add my-server npx my-mcp   # Add custom server
    aii mcp list-tools github          # Discover tools
    aii mcp test github                # Connectivity test

    MCP servers connect in the background during session start โ€” no waiting on first use. If a server drops, use /mcp reconnect <server> or /mcp reconnect all to restore it without restarting your session.

    Server Sessions

    Conversations persist across restarts and channels:

    aii sessions list                  # Browse recent sessions
    aii sessions resume <id>           # Pick up where you left off
    aii sessions info <id>             # View stats (tokens, cost, tools)

    Configuration

    aii config init                          # Interactive setup wizard
    aii config show                          # Current settings
    aii config validate                      # Check config + API key validity
    aii config set <key> <value>             # Set a specific value
    aii config provider [name]               # Show or switch provider
    aii config model [name]                  # Show or switch model
    aii config apikey <provider> [key]       # Set API key (masked input)
    aii config apikey list                   # Show all provider key status
    aii config apikey remove <provider>      # Remove a provider's key
    aii config apikey help                   # Show API key help
    aii config host [host:port]              # Show or change server URL
    aii config models                        # List all available models
    aii config providers                     # List all providers with status
    aii config help                          # Show config help

    Config lives in ~/.aii/:

    File Purpose
    config.yaml Provider, model, server host, preferences
    secrets.yaml API keys (file mode 0600)
    mcp_servers.json MCP server configuration

    Environment variables also work: ANTHROPIC_API_KEY, OPENAI_API_KEY, DEEPSEEK_API_KEY, etc.


    CLI Reference

    Command Description
    aii Start interactive agent session
    aii <query> Single-shot query
    aii run git commit [-y] AI-powered git commit
    aii loop [query] [--flags] Autonomous agent loop
    aii config <action> Configuration management
    aii mcp <action> MCP server management
    aii telegram <action> Telegram bot management
    aii sessions <action> Session management
    aii soul <action> Soul (personality) management
    aii worktree <action> Git worktree management
    aii prompt <action> Prompt library
    aii doctor Health diagnostics
    aii help Show help
    aii version Show version

    Global Flags

    Flag Description
    --model <name> Override model (e.g., deepseek/deepseek-chat)
    --auto Auto-approve all tool actions
    -y, --yes Auto-confirm prompts
    -c, --continue-chat <id> Resume a specific session
    -n, --new-chat Force new session
    -i, --interactive Force interactive mode
    --offline Disable web search and MCP
    -D, --direct Direct LLM mode (bypass server intent recognition)
    --no-colors Disable colors
    --no-streaming Disable streaming output
    --show-tokens Show token usage
    --show-cost Show cost estimates
    -v, --verbose Verbose output
    -d, --debug Debug-level output

    Troubleshooting

    Run aii doctor for automated diagnostics.

    Problem Fix
    aii not found npm install -g @aiiware/aii, restart terminal
    Server won't start Make sure Docker is running
    API key error aii config apikey <provider> <key> or aii config init
    Wrong model aii config model <name>
    Ollama not connecting Start Ollama first, then aii config provider ollama
    Context window full /context clear during session


    License: Proprietary โ€” Copyright 2025-present AiiWare.com. All rights reserved.