indusagi-coding-agent 0.1.2 → 0.1.3

package/README.md

@@ -1,540 +1,54 @@
 # indusagi-coding-agent
 
-[![npm](https://img.shields.io/npm/v/indusagi-coding-agent?style=flat-square)](https://www.npmjs.com/package/indusagi-coding-agent)
-[Repository](https://github.com/varunisrani/indusagi-ts)
+A terminal-first coding agent with a small core and strong extensibility. Use it interactively, in scripts (print/JSON), over RPC, or as an SDK in your own apps.
 
-Indusagi is a minimal terminal coding harness. Adapt indusagi to your workflows, not the other way around, without having to fork and modify indusagi internals. Extend it with TypeScript [Extensions](#extensions), [Skills](#skills), [Prompt Templates](#prompt-templates), and [Themes](#themes). Put your extensions, skills, prompt templates, and themes in [Indusagi Packages](#indusagi-packages) and share them with others via npm or git.
+- CLI commands: `indusagi` and `indus`
+- Node.js >= 20
+- Extensible via extensions, skills, prompt templates, and themes
 
-Indusagi ships with powerful defaults but skips features like sub agents and plan mode. Instead, you can ask indusagi to build what you want or install a third party indusagi package that matches your workflow.
+If you want the all-in-one bundle (ai + agent + tui + webui + coding agent), use:
 
-Indusagi runs in four modes: interactive, print or JSON, RPC for process integration, and an SDK for embedding in your own apps. See [clawdbot/clawdbot](https://github.com/clawdbot/clawdbot) for a real-world SDK integration.
+- https://www.npmjs.com/package/indusagi
 
-## Table of Contents
-
-- [Quick Start](#quick-start)
-- [Providers & Models](#providers--models)
-- [Interactive Mode](#interactive-mode)
-  - [Editor](#editor)
-  - [Commands](#commands)
-  - [Keyboard Shortcuts](#keyboard-shortcuts)
-  - [Message Queue](#message-queue)
-- [Sessions](#sessions)
-  - [Branching](#branching)
-  - [Compaction](#compaction)
-- [Settings](#settings)
-- [Context Files](#context-files)
-- [Customization](#customization)
-  - [Prompt Templates](#prompt-templates)
-  - [Skills](#skills)
-  - [Extensions](#extensions)
-  - [Themes](#themes)
-  - [Indusagi Packages](#indusagi-packages)
-- [Programmatic Usage](#programmatic-usage)
-- [Philosophy](#philosophy)
-- [CLI Reference](#cli-reference)
-
----
-
-## Quick Start
+## Install
 
 ```bash
 npm install -g indusagi-coding-agent
 ```
 
-Authenticate with an API key:
-
-```bash
-export ANTHROPIC_AINDUSAGI_KEY=sk-ant-...
-indusagi
-```
-
-Or use your existing subscription:
+## Quick Start
 
 ```bash
 indusagi
-/login  # Then select provider
 ```
 
-Then just talk to indusagi. By default, indusagi gives the model four tools: `read`, `write`, `edit`, and `bash`. The model uses these to fulfill your requests. Add capabilities via [skills](#skills), [prompt templates](#prompt-templates), [extensions](#extensions), or [indusagi packages](#indusagi-packages).
-
-**Platform notes:** [Windows](docs/windows.md) | [Terminal setup](docs/terminal-setup.md) | [Shell aliases](docs/shell-aliases.md)
-
----
-
-## Providers & Models
-
-For each built-in provider, indusagi maintains a list of tool-capable models, updated with every release. Authenticate via subscription (`/login`) or API key, then select any model from that provider via `/model` (or Ctrl+L).
-
-**Subscriptions:**
-- Anthropic Claude Pro/Max
-- OpenAI ChatGPT Plus/Pro (Codex)
-- GitHub Copilot
-- Google Gemini CLI
-- Google Antigravity
-
-**API keys:**
-- Anthropic
-- OpenAI
-- Azure OpenAI
-- Google Gemini
-- Google Vertex
-- Amazon Bedrock
-- Mistral
-- Groq
-- Cerebras
-- xAI
-- OpenRouter
-- Vercel AI Gateway
-- ZAI
-- OpenCode Zen
-- MiniMax
-
-See [docs/providers.md](docs/providers.md) for detailed setup instructions.
-
-**Custom providers & models:** Add providers via `~/.indusagi/agent/models.json` if they speak a supported API (OpenAI, Anthropic, Google). For custom APIs or OAuth, use extensions. See [docs/models.md](docs/models.md) and [docs/custom-provider.md](docs/custom-provider.md).
-
----
-
-## Interactive Mode
-
-<p align="center"><img src="docs/images/interactive-mode.png" alt="Interactive Mode" width="600"></p>
-
-The interface from top to bottom:
-
-- **Startup header** - Shows shortcuts (`/hotkeys` for all), loaded AGENTS.md files, prompt templates, skills, and extensions
-- **Messages** - Your messages, assistant responses, tool calls and results, notifications, errors, and extension UI
-- **Editor** - Where you type; border color indicates thinking level
-- **Footer** - Working directory, session name, total token/cache usage, cost, context usage, current model
-
-The editor can be temporarily replaced by other UI, like built-in `/settings` or custom UI from extensions (e.g., a Q&A tool that lets the user answer model questions in a structured format). [Extensions](#extensions) can also replace the editor, add widgets above/below it, a status line, custom footer, or overlays.
-
-### Editor
-
-| Feature | How |
-|---------|-----|
-| File reference | Type `@` to fuzzy-search project files |
-| Path completion | Tab to complete paths |
-| Multi-line | Shift+Enter (or Ctrl+Enter on Windows Terminal) |
-| Images | Ctrl+V to paste, or drag onto terminal |
-| Bash commands | `!command` runs and sends output to LLM, `!!command` runs without sending |
-
-Standard editing keybindings for delete word, undo, etc. See [docs/keybindings.md](docs/keybindings.md).
-
-### Commands
-
-Type `/` in the editor to trigger commands. [Extensions](#extensions) can register custom commands, [skills](#skills) are available as `/skill:name`, and [prompt templates](#prompt-templates) expand via `/templatename`.
-
-| Command | Description |
-|---------|-------------|
-| `/login`, `/logout` | OAuth authentication |
-| `/model` | Switch models |
-| `/scoped-models` | Enable/disable models for Ctrl+P cycling |
-| `/settings` | Thinking level, theme, message delivery |
-| `/resume` | Pick from previous sessions |
-| `/new` | Start a new session |
-| `/name <name>` | Set session display name |
-| `/session` | Show session info (path, tokens, cost) |
-| `/tree` | Jump to any point in the session and continue from there |
-| `/fork` | Create a new session from the current branch |
-| `/compact [prompt]` | Manually compact context, optional custom instructions |
-| `/copy` | Copy last assistant message to clipboard |
-| `/export [file]` | Export session to HTML file |
-| `/share` | Upload as private GitHub gist with shareable HTML link |
-| `/reload` | Reload extensions, skills, prompts, context files (themes hot-reload automatically) |
-| `/hotkeys` | Show all keyboard shortcuts |
-| `/changelog` | Display version history |
-| `/quit`, `/exit` | Quit indusagi |
-
-### Keyboard Shortcuts
-
-See `/hotkeys` for the full list. Customize via `~/.indusagi/agent/keybindings.json`. See [docs/keybindings.md](docs/keybindings.md).
-
-**Commonly used:**
-
-| Key | Action |
-|-----|--------|
-| Ctrl+C | Clear editor |
-| Ctrl+C twice | Quit |
-| Escape | Cancel/abort |
-| Escape twice | Open `/tree` |
-| Ctrl+L | Open model selector |
-| Ctrl+P / Shift+Ctrl+P | Cycle scoped models forward/backward |
-| Shift+Tab | Cycle thinking level |
-| Ctrl+O | Collapse/expand tool output |
-| Ctrl+T | Collapse/expand thinking blocks |
-
-### Message Queue
-
-Submit messages while the agent is working:
-
-- **Enter** queues a *steering* message, delivered after current tool execution (interrupts remaining tools)
-- **Alt+Enter** queues a *follow-up* message, delivered only after the agent finishes all work
-- **Escape** aborts and restores queued messages to editor
-- **Alt+Up** retrieves queued messages back to editor
-
-Configure delivery in [settings](docs/settings.md): `steeringMode` and `followUpMode` can be `"one-at-a-time"` (default, waits for response) or `"all"` (delivers all queued at once).
-
----
-
-## Sessions
-
-Sessions are stored as JSONL files with a tree structure. Each entry has an `id` and `parentId`, enabling in-place branching without creating new files. See [docs/session.md](docs/session.md) for file format.
+Authenticate using `/login` or set provider API keys. See `docs/providers.md` for details.
 
-### Management
-
-Sessions auto-save to `~/.indusagi/agent/sessions/` organized by working directory.
+Example (file-aware prompt):
 
 ```bash
-indusagi -c                  # Continue most recent session
-indusagi -r                  # Browse and select from past sessions
-indusagi --no-session        # Ephemeral mode (don't save)
-indusagi --session <path>    # Use specific session file or ID
+indusagi @src/index.ts "Summarize this file"
 ```
 
-### Branching
-
-**`/tree`** - Navigate the session tree in-place. Select any previous point, continue from there, and switch between branches. All history preserved in a single file.
-
-<p align="center"><img src="docs/images/tree-view.png" alt="Tree View" width="600"></p>
-
-- Search by typing, page with ←/→
-- Filter modes (Ctrl+O): default → no-tools → user-only → labeled-only → all
-- Press `l` to label entries as bookmarks
-
-**`/fork`** - Create a new session file from the current branch. Opens a selector, copies history up to the selected point, and places that message in the editor for modification.
-
-### Compaction
-
-Long sessions can exhaust context windows. Compaction summarizes older messages while keeping recent ones.
-
-**Manual:** `/compact` or `/compact <custom instructions>`
-
-**Automatic:** Enabled by default. Triggers on context overflow (recovers and retries) or when approaching the limit (proactive). Configure via `/settings` or `settings.json`.
-
-Compaction is lossy. The full history remains in the JSONL file; use `/tree` to revisit. Customize compaction behavior via [extensions](#extensions). See [docs/compaction.md](docs/compaction.md) for internals.
-
----
-
-## Settings
-
-Use `/settings` to modify common options, or edit JSON files directly:
-
-| Location | Scope |
-|----------|-------|
-| `~/.indusagi/agent/settings.json` | Global (all projects) |
-| `.indusagi/settings.json` | Project (overrides global) |
-
-See [docs/settings.md](docs/settings.md) for all options.
-
----
-
-## Context Files
-
-Indusagi loads `AGENTS.md` (or `CLAUDE.md`) at startup from:
-- `~/.indusagi/agent/AGENTS.md` (global)
-- Parent directories (walking up from cwd)
-- Current directory
-
-Use for project instructions, conventions, common commands. All matching files are concatenated.
-
-### System Prompt
+## Modes
 
-Replace the default system prompt with `.indusagi/SYSTEM.md` (project) or `~/.indusagi/agent/SYSTEM.md` (global). Append without replacing via `APPEND_SYSTEM.md`.
-
----
+- Interactive mode (default)
+- Print/JSON modes for scripting (`docs/json.md`)
+- RPC mode for process integration (`docs/rpc.md`)
+- SDK usage (`docs/sdk.md`)
 
 ## Customization
 
-### Prompt Templates
-
-Reusable prompts as Markdown files. Type `/name` to expand.
-
-```markdown
-<!-- ~/.indusagi/agent/prompts/review.md -->
-Review this code for bugs, security issues, and performance problems.
-Focus on: {{focus}}
-```
-
-Place in `~/.indusagi/agent/prompts/`, `.indusagi/prompts/`, or a [indusagi package](#indusagi-packages) to share with others. See [docs/prompt-templates.md](docs/prompt-templates.md).
-
-### Skills
-
-On-demand capability packages following the [Agent Skills standard](https://agentskills.io). Invoke via `/skill:name` or let the agent load them automatically.
-
-```markdown
-<!-- ~/.indusagi/agent/skills/my-skill/SKILL.md -->
-# My Skill
-Use this skill when the user asks about X.
-
-## Steps
-1. Do this
-2. Then that
-```
-
-Place in `~/.indusagi/agent/skills/`, `.indusagi/skills/`, or a [indusagi package](#indusagi-packages) to share with others. See [docs/skills.md](docs/skills.md).
-
-### Extensions
-
-<p align="center"><img src="docs/images/doom-extension.png" alt="Doom Extension" width="600"></p>
-
-TypeScript modules that extend indusagi with custom tools, commands, keyboard shortcuts, event handlers, and UI components.
-
-```typescript
-export default function (indusagi: ExtensionAPI) {
-  indusagi.registerTool({ name: "deploy", ... });
-  indusagi.registerCommand("stats", { ... });
-  indusagi.on("tool_call", async (event, ctx) => { ... });
-}
-```
-
-**What's possible:**
-- Custom tools (or replace built-in tools entirely)
-- Sub-agents and plan mode
-- Custom compaction and summarization
-- Permission gates and path protection
-- Custom editors and UI components
-- Status lines, headers, footers
-- Git checkpointing and auto-commit
-- SSH and sandbox execution
-- MCP server integration
-- Make indusagi look like Claude Code
-- Games while waiting (yes, Doom runs)
-- ...anything you can dream up
-
-Place in `~/.indusagi/agent/extensions/`, `.indusagi/extensions/`, or a [indusagi package](#indusagi-packages) to share with others. See [docs/extensions.md](docs/extensions.md) and [examples/extensions/](examples/extensions/).
-
-### Themes
-
-Built-in: `dark`, `light`. Themes hot-reload: modify the active theme file and indusagi immediately applies changes.
+- Extensions: `docs/extensions.md`
+- Skills: `docs/skills.md`
+- Prompt templates: `docs/prompt-templates.md`
+- Themes: `docs/themes.md`
+- Packages: `docs/packages.md`
 
-Place in `~/.indusagi/agent/themes/`, `.indusagi/themes/`, or a [indusagi package](#indusagi-packages) to share with others. See [docs/themes.md](docs/themes.md).
+## Configuration
 
-### Indusagi Packages
-
-Bundle and share extensions, skills, prompts, and themes via npm or git. Find packages on [npmjs.com](https://www.npmjs.com/search?q=keywords%3Api-package) or [Discord](https://discord.com/channels/1456806362351669492/1457744485428629628).
-
-> **Security:** Indusagi packages run with full system access. Extensions execute arbitrary code, and skills can instruct the model to perform any action including running executables. Review source code before installing third-party packages.
-
-```bash
-indusagi install npm:@foo/indusagi-tools
-indusagi install npm:@foo/indusagi-tools@1.2.3      # pinned version
-indusagi install git:github.com/user/repo
-indusagi install git:github.com/user/repo@v1  # tag or commit
-indusagi install https://github.com/user/repo
-indusagi remove npm:@foo/indusagi-tools
-indusagi list
-indusagi update                               # skips pinned packages
-indusagi config                               # enable/disable extensions, skills, prompts, themes
-```
-
-Packages install to `~/.indusagi/agent/git/` (git) or global npm. Use `-l` for project-local installs (`.indusagi/git/`, `.indusagi/npm/`).
-
-Create a package by adding a `indusagi` key to `package.json`:
-
-```json
-{
-  "name": "my-indusagi-package",
-  "keywords": ["indusagi-package"],
-  "indusagi": {
-    "extensions": ["./extensions"],
-    "skills": ["./skills"],
-    "prompts": ["./prompts"],
-    "themes": ["./themes"]
-  }
-}
-```
-
-Without a `indusagi` manifest, indusagi auto-discovers from conventional directories (`extensions/`, `skills/`, `prompts/`, `themes/`).
-
-See [docs/packages.md](docs/packages.md).
-
----
-
-## Programmatic Usage
-
-### SDK
-
-```typescript
-import { AuthStorage, createAgentSession, ModelRegistry, SessionManager } from "indusagi-coding-agent";
-
-const { session } = await createAgentSession({
-  sessionManager: SessionManager.inMemory(),
-  authStorage: new AuthStorage(),
-  modelRegistry: new ModelRegistry(authStorage),
-});
-
-await session.prompt("What files are in the current directory?");
-```
-
-See [docs/sdk.md](docs/sdk.md) and [examples/sdk/](examples/sdk/).
-
-### RPC Mode
-
-For non-Node.js integrations, use RPC mode over stdin/stdout:
-
-```bash
-indusagi --mode rpc
-```
-
-See [docs/rpc.md](docs/rpc.md) for the protocol.
-
----
-
-## Philosophy
-
-Indusagi is aggressively extensible so it doesn't have to dictate your workflow. Features that other tools bake in can be built with [extensions](#extensions), [skills](#skills), or installed from third-party [indusagi packages](#indusagi-packages). This keeps the core minimal while letting you shape indusagi to fit how you work.
-
-**No MCP.** Build CLI tools with READMEs (see [Skills](#skills)), or build an extension that adds MCP support. [Why?](https://mariozechner.at/posts/2025-11-02-what-if-you-dont-need-mcp/)
-
-**No sub-agents.** There's many ways to do this. Spawn indusagi instances via tmux, or build your own with [extensions](#extensions), or install a package that does it your way.
-
-**No permission popups.** Run in a container, or build your own confirmation flow with [extensions](#extensions) inline with your environment and security requirements.
-
-**No plan mode.** Write plans to files, or build it with [extensions](#extensions), or install a package.
-
-**No built-in to-dos.** They confuse models. Use a TODO.md file, or build your own with [extensions](#extensions).
-
-**No background bash.** Use tmux. Full observability, direct interaction.
-
-Read the [blog post](https://mariozechner.at/posts/2025-11-30-indusagi-coding-agent/) for the full rationale.
-
----
-
-## CLI Reference
-
-```bash
-indusagi [options] [@files...] [messages...]
-```
-
-### Package Commands
-
-```bash
-indusagi install <source> [-l]    # Install package, -l for project-local
-indusagi remove <source> [-l]     # Remove package
-indusagi update [source]          # Update packages (skips pinned)
-indusagi list                     # List installed packages
-indusagi config                   # Enable/disable package resources
-```
-
-### Modes
-
-| Flag | Description |
-|------|-------------|
-| (default) | Interactive mode |
-| `-p`, `--print` | Print response and exit |
-| `--mode json` | Output all events as JSON lines (see [docs/json.md](docs/json.md)) |
-| `--mode rpc` | RPC mode for process integration (see [docs/rpc.md](docs/rpc.md)) |
-| `--export <in> [out]` | Export session to HTML |
-
-### Model Options
-
-| Option | Description |
-|--------|-------------|
-| `--provider <name>` | Provider (anthropic, openai, google, etc.) |
-| `--model <id>` | Model ID |
-| `--api-key <key>` | API key (overrides env vars) |
-| `--thinking <level>` | `off`, `minimal`, `low`, `medium`, `high`, `xhigh` |
-| `--models <patterns>` | Comma-separated patterns for Ctrl+P cycling |
-| `--list-models [search]` | List available models |
-
-### Session Options
-
-| Option | Description |
-|--------|-------------|
-| `-c`, `--continue` | Continue most recent session |
-| `-r`, `--resume` | Browse and select session |
-| `--session <path>` | Use specific session file or partial UUID |
-| `--session-dir <dir>` | Custom session storage directory |
-| `--no-session` | Ephemeral mode (don't save) |
-
-### Tool Options
-
-| Option | Description |
-|--------|-------------|
-| `--tools <list>` | Enable specific built-in tools (default: `read,bash,edit,write`) |
-| `--no-tools` | Disable all built-in tools (extension tools still work) |
-
-Available built-in tools: `read`, `bash`, `edit`, `write`, `grep`, `find`, `ls`
-
-### Resource Options
-
-| Option | Description |
-|--------|-------------|
-| `-e`, `--extension <source>` | Load extension from path, npm, or git (repeatable) |
-| `--no-extensions` | Disable extension discovery |
-| `--skill <path>` | Load skill (repeatable) |
-| `--no-skills` | Disable skill discovery |
-| `--prompt-template <path>` | Load prompt template (repeatable) |
-| `--no-prompt-templates` | Disable prompt template discovery |
-| `--theme <path>` | Load theme (repeatable) |
-| `--no-themes` | Disable theme discovery |
-
-Combine `--no-*` with explicit flags to load exactly what you need, ignoring settings.json (e.g., `--no-extensions -e ./my-ext.ts`).
-
-### Other Options
-
-| Option | Description |
-|--------|-------------|
-| `--system-prompt <text>` | Replace default prompt (context files and skills still appended) |
-| `--append-system-prompt <text>` | Append to system prompt |
-| `--verbose` | Force verbose startup |
-| `-h`, `--help` | Show help |
-| `-v`, `--version` | Show version |
-
-### File Arguments
-
-Prefix files with `@` to include in the message:
-
-```bash
-indusagi @prompt.md "Answer this"
-indusagi -p @screenshot.png "What's in this image?"
-indusagi @code.ts @test.ts "Review these files"
-```
-
-### Examples
-
-```bash
-# Interactive with initial prompt
-indusagi "List all .ts files in src/"
-
-# Non-interactive
-indusagi -p "Summarize this codebase"
-
-# Different model
-indusagi --provider openai --model gpt-4o "Help me refactor"
-
-# Limit model cycling
-indusagi --models "claude-*,gpt-4o"
-
-# Read-only mode
-indusagi --tools read,grep,find,ls -p "Review the code"
-
-# High thinking level
-indusagi --thinking high "Solve this complex problem"
-```
-
-### Environment Variables
-
-| Variable | Description |
-|----------|-------------|
-| `INDUSAGI_CODING_AGENT_DIR` | Override config directory (default: `~/.indusagi/agent`) |
-| `INDUSAGI_SKIP_VERSION_CHECK` | Skip version check at startup |
-| `VISUAL`, `EDITOR` | External editor for Ctrl+G |
-
----
-
-## Contributing & Development
-
-See [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines and [docs/development.md](docs/development.md) for setup, forking, and debugging.
-
----
+Settings can be global or project-specific. See `docs/settings.md`.
 
 ## License
 
 MIT
-
-## See Also
-
-- [indusagi-ai](https://www.npmjs.com/package/indusagi-ai): Core LLM toolkit
-- [@mariozechner/indusagi-agent](https://www.npmjs.com/package/@mariozechner/indusagi-agent): Agent framework
-- [indusagi-tui](https://www.npmjs.com/package/indusagi-tui): Terminal UI components

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "indusagi-coding-agent",
-	"version": "0.1.2",
+	"version": "0.1.3",
 	"description": "Coding agent CLI with read, bash, edit, write tools and session management",
 	"type": "module",
 	"indusagiConfig": {
@@ -77,9 +77,10 @@
 	"license": "MIT",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/badlogic/indusagi-mono.git",
-		"directory": "packages/coding-agent"
+		"url": "git+https://github.com/varunisrani/indusagi-ts.git",
+		"directory": "indusagi-coding-agent"
 	},
+	"homepage": "https://www.npmjs.com/package/indusagi",
 	"engines": {
 		"node": ">=20.0.0"
 	}