codethon-cli
v1.1.0
Published
AI-native execution orchestration for developers and hackathon builders — plan, build, debug, and ship from your terminal.
Maintainers
Readme
CodeThon CLI
Provider-agnostic AI coding agent for the terminal. CodeThon helps you configure a model, understand a repo, plan the work, execute concrete tasks, recover from failures, and ship from one CLI.
npm install -g codethon-cli
ctCurrent package: [email protected]
First Run
Run ct.
If no working provider is configured, CodeThon starts guided setup:
- Choose OpenAI, Anthropic, NVIDIA, Groq, DeepSeek, Together, Ollama, or LM Studio.
- Enter an API key when the provider requires one.
- Validate the key.
- Select a model.
- Run a test request.
- Save config and show next actions.
CodeThon stores configuration in the user's home directory, not inside the npm package folder and not inside your source tree.
Terminal UI
CodeThon uses solid terminal icons instead of emoji. The symbols are designed to stay aligned in PowerShell, Windows Terminal, macOS Terminal, Linux terminals, and CI logs.
| Icon | Meaning |
|---|---|
| ◆ | Completed successfully |
| ▲ | Warning or user attention needed |
| ■ | Failed or blocked |
| ● | Active work |
| ▣ | Queued, checkpoint, or captured state |
| ▶ | Running or starting an action |
Interactive Mode
CodeThon >Use ct once to open the workspace, then use slash commands inside CodeThon.
Standalone commands such as ct doctor still work for scripts, but the primary
builder workflow is /init, /plan, /execute, /analyze, and /profile.
| Input | Result |
|---|---|
| / | Open the slash-command palette |
| /p | Filter commands such as /plan and /profile |
| /help | Show categorized command help |
| plain English | Ask the configured AI provider |
Common Workflow
/auth add
/init
/plan build a Next.js dashboard with Supabase auth
/execute implement the dashboard shell and auth flow
/profile
/doctorExecute Workspace Controls
/execute <goal> opens the OLED autonomous workspace. It keeps the mission,
live trace, context, diffs, agents, and final receipt inside one terminal screen.
| Key | Action |
|---|---|
| Ctrl+M | Open Mission Control |
| Ctrl+T | Open the live activity trace |
| Ctrl+I | Open Context Inspector |
| Ctrl+D | Open Diff Inspector |
| Ctrl+A | Open the agent matrix |
| Esc | Close the active drawer; if no drawer is open, cancel the active run |
| Ctrl+C | Gracefully cancel the active run; press again only if it is stuck |
Commands
Setup
| Command | Purpose |
|---|---|
| /onboard | Run guided setup again |
| /auth add | Add and validate a provider credential |
| /auth list | Show configured providers and active model |
| /auth test [provider] | Test provider authentication |
| /auth switch | Switch provider and model |
| /auth remove [provider] | Remove a provider credential |
| /auth logout | Remove credentials and reset auth state |
| /model | Browse and switch models |
| /doctor | Diagnose Node, Git, config, auth, network, and project health |
Plan And Understand
| Command | Purpose |
|---|---|
| /init | Create or register a project workspace |
| /plan [goal] | Stream roadmap and architecture generation |
| /roadmap | Generate phases and milestones |
| /architect | Generate architecture and stack guidance |
| /analyze [dir] | Scan project structure and stream an AI summary |
| /explain <file> | Explain a file and its risks |
| /summarize | Summarize project health, blockers, and priorities |
Build And Repair
| Command | Purpose |
|---|---|
| /execute <goal> | Run the autonomous agent loop on a concrete task |
| /build [goal] | Generate and apply code with build repair |
| /autofix | Run build/type checks and apply targeted fixes |
| /debug | Analyze errors and stream fix guidance |
| /run <cmd> | Run a shell command through policy gates |
| /scaffold [dir] | Generate a starter project |
Inspect, Recover, Ship
| Command | Purpose |
|---|---|
| /profile | Find performance issues and code smells |
| /review | Inspect current git changes |
| /diff | Show the full git diff |
| /checkpoint | Save, list, and restore recovery points |
| /recover | Rebuild project context from local files |
| /deploy | Generate deployment guidance |
| /readme | Generate or refresh README.md |
| /launch | Generate demo script and submission copy |
| /startup | Analyze product and go-to-market potential |
| /learn | Ask a concept question and get a guided tutorial |
Providers
| Provider | Credential |
|---|---|
| NVIDIA | NVIDIA_API_KEY |
| OpenAI | OPENAI_API_KEY |
| Anthropic | ANTHROPIC_API_KEY |
| Groq | GROQ_API_KEY |
| DeepSeek | DEEPSEEK_API_KEY |
| Together AI | TOGETHER_API_KEY |
| Ollama | none |
| LM Studio / local server | none |
Safety
--askgates writes and command execution.--dry-runpreviews operations.- shell execution uses allowlisted binaries and blocked dangerous patterns.
- child-process environments are filtered for common secret patterns.
- provider credentials are stored outside project files.
.envplaceholder writes are rejected.
/execute add password reset
/debug
/autofixDevelopment
git clone https://github.com/zubershk/CodeThon-CLI
cd CodeThon-CLI
npm install
npm run build
npm test
npm run typecheckRun the local build:
node apps/cli/dist/index.jsInspect the npm package:
cd apps/cli
npm pack --dry-runLicense
MIT
