Skip to content

Repository files navigation

Codeany

ReleaseGoLicense

An open-source AI-powered terminal agent for software engineering. Built in Go with Bubble Tea TUI and the Open Agent SDK.

78 slash commands | Skills & Plugins | MCP support | Multi-provider | Chinese/IME | Self-update

Quick Install

curl -fsSL https://raw.githubusercontent.com/codeany-ai/codeany/main/install.sh | sh

Or install from source:

go install github.com/codeany-ai/codeany/cmd/codeany@latest

Setup

Set your API key:

export ANTHROPIC_API_KEY="sk-ant-..."# Or for OpenRouter / custom providers:export CODEANY_API_KEY="sk-or-..."export CODEANY_BASE_URL="https://openrouter.ai/api"export CODEANY_MODEL="anthropic/claude-sonnet-4-5"

Usage

# Interactive mode
codeany
# With initial prompt
codeany "explain this codebase"# Pipe modeecho"what is 2+2"| codeany -p
# Print mode (non-interactive)
codeany --print -y "list files in src/"# JSON outputecho"hello"| codeany -p -y --output-format json
# Skip permission prompts
codeany -y
# Use specific model
codeany -m opus-4-6

Slash Commands

CommandDescription
/helpShow all commands
/model [name]Switch model
/fastToggle faster model
/costShow token usage and cost
/clearClear conversation
/compact [hint]Compact conversation
/plan [task]Plan mode / plan a task
/commit [msg]Git commit helper
/review [target]Code review
/diffShow git diff summary
/bug <desc>Investigate a bug
/test [target]Run tests
/initInitialize project (create CODEANY.md)
/doctorEnvironment diagnostics
/mcpManage MCP servers
/skillsList available skills
/pluginList installed plugins
/hooksShow configured hooks
/contextShow all context sources
/sessionSession details
/filesFiles accessed this session
/resumeList recent sessions
/exportExport conversation
/configShow configuration
/permissionsPermission mode
/statusSession status
/quitExit

Keyboard Shortcuts

KeyAction
EnterSend message
Shift+EnterNew line
Ctrl+CCancel / Exit
Ctrl+DExit (empty input)
Ctrl+LClear conversation
Ctrl+OToggle expand tool output
Up/DownInput history
PgUp/PgDownScroll messages
TabComplete slash command
EscClear input / close menu
! cmdRun shell command

Configuration

Config directory: ~/.codeany/

~/.codeany/
├── settings.json # Main config (model, permissions, MCP, hooks)
├── config.yaml # YAML config (alternative)
├── permissions.json # Persisted permission rules
├── memory/ # Memory files
├── sessions/ # Session history
├── skills/ # User skills
│ └── my-skill/
│ └── SKILL.md
└── plugins/ # Plugins
└── my-plugin/
├── plugin.json
└── skills/

settings.json

{
"model": "sonnet-4-6",
"permissionMode": "default",
"maxTurns": 100,
"mcpServers": {
"filesystem": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/tmp"]
}
},
"hooks": {
"preToolUse": [],
"postToolUse": []
}
}

Project Configuration

Create CODEANY.md (or CLAUDE.md) in your project root:

# Project Instructions## Commands-`npm test` to run tests
-`npm run build` to build
## Code Style- Use TypeScript strict mode
- Prefer functional components

Also supports:

  • CODEANY.local.md / CLAUDE.local.md — personal, gitignored
  • .codeany/rules/*.md / .claude/rules/*.md — modular rules

Skills

Create custom skills in .codeany/skills/<name>/SKILL.md:

---name: deploydescription: Deploy to productionargumentHint: <environment>---
Deploy the application to $ARGUMENTS environment.
Run the deployment script and verify health checks.

Invoke with: /deploy staging

MCP Servers

Configure MCP servers in settings.json or manage with /mcp:

/mcp # List servers
/mcp tools # List available tools
/mcp reconnect X # Reconnect server

Update

codeany update

License

MIT

About

Open-source AI-powered terminal agent. Built in Go.

Resources

Stars

183 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages