Skip to content

Commit 427fa8d

Browse files
Bulat Skill7claude
andcommitted
chore: remove OpenCode ASCII logo and rewrite README
- Remove the "OPENCODE" ASCII art banner from CLI startup, upgrade, and uninstall commands — no value in a headless harness - Delete logo.ts and logo rendering code from ui.ts - Set process.env.AICTRL alongside OPENCODE (compat) at startup - Rewrite README with install, usage, config, models, SDK, and monorepo docs — developer-friendly instead of marketing copy Co-Authored-By: Claude Opus 4.6 <[email protected]>
1 parent ded9ecf commit 427fa8d

7 files changed

Lines changed: 114 additions & 79 deletions

File tree

‎README.md‎

Lines changed: 110 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,132 @@
22
<img src=".github/logo.svg" alt="aictrl.dev" width="240" />
33
</p>
44

5-
<h3 align="center">The Lightweight Headless Runtime for AI Agent Skills</h3>
5+
<h3 align="center">Headless execution engine for AI agent skills</h3>
66

7-
---
8-
9-
Aictrl CLI is a 100% headless, server-side execution harness designed for autonomous agentic workflows. It provides a secure, modular environment to run, measure, and scale agent skills without the bloat of a desktop or terminal UI.
7+
<p align="center">
8+
<a href="https://www.npmjs.com/package/@aictrl/cli"><img src="https://img.shields.io/npm/v/@aictrl/cli" alt="npm" /></a>
9+
<a href="https://github.com/aictrl-dev/cli/blob/main/LICENSE"><img src="https://img.shields.io/github/license/aictrl-dev/cli" alt="license" /></a>
10+
</p>
1011

11-
## Key Features
12+
---
1213

13-
- **Headless First:** Built specifically for server-side automation, Cloud Run, and CI/CD pipelines.
14-
- **Skill-Native:** Native support for the `SKILL.md` format for modular procedural knowledge.
15-
- **Agent Teams:** Robust support for subagent delegation and parallel execution.
16-
- **Deep Telemetry:** Instrumented with granular hooks for measuring skill usage and subagent lifecycles.
17-
- **Vendor Agnostic:** Compatible with Anthropic, OpenAI, Gemini, and local models via Ollama.
18-
- **MCP Support:** Seamless integration with Model Context Protocol servers.
14+
Aictrl is a headless, server-side runtime for autonomous AI agent workflows. Run agent skills in CI/CD pipelines, Cloud Run, or any environment — no terminal UI required.
1915

20-
## Installation
16+
## Install
2117

2218
```bash
2319
npm i -g @aictrl/cli
2420
```
2521

26-
## Quick Start
22+
## Usage
2723

28-
Run a task headlessly:
24+
### Run a task
2925

3026
```bash
3127
aictrl run "analyze the security of this repository"
3228
```
3329

30+
### Use a specific model
31+
32+
```bash
33+
aictrl run --model anthropic/claude-sonnet-4-20250514 "refactor the auth module"
34+
```
35+
36+
### JSON output for pipelines
37+
38+
```bash
39+
aictrl run --format json "review this PR" | jq '.type'
40+
```
41+
42+
### Attach files
43+
44+
```bash
45+
aictrl run --file screenshot.png "what's wrong with this UI?"
46+
```
47+
48+
## Configuration
49+
50+
Aictrl reads configuration from `.aictrl/` directories (project-level and `~/.config/aictrl/` global).
51+
52+
### Models
53+
54+
Any model from any supported provider. Set the API key as an env var:
55+
56+
| Provider | Env Var | Example Model |
57+
|----------|---------|---------------|
58+
| Anthropic | `ANTHROPIC_API_KEY` | `anthropic/claude-sonnet-4-20250514` |
59+
| OpenAI | `OPENAI_API_KEY` | `openai/gpt-4o` |
60+
| Google | `GOOGLE_API_KEY` | `google/gemini-2.5-pro` |
61+
| OpenRouter | `OPENROUTER_API_KEY` | `openrouter/...` |
62+
| ZhipuAI | `ZHIPU_API_KEY` | `zai-coding-plan/glm-5` |
63+
64+
Run `aictrl models` for the full list.
65+
66+
### Skills
67+
68+
Skills are modular agent capabilities defined as `SKILL.md` files. Place them in:
69+
70+
- `.aictrl/skills/` (project-level)
71+
- `~/.config/aictrl/skills/` (global)
72+
73+
### MCP Servers
74+
75+
Configure MCP servers for external tool integration:
76+
77+
```bash
78+
aictrl mcp add my-server --url http://localhost:8080
79+
```
80+
81+
### Custom Tools
82+
83+
Drop TypeScript files in `.aictrl/tool/` or `.aictrl/tools/` to register custom tools.
84+
85+
## Commands
86+
87+
| Command | Description |
88+
|---------|-------------|
89+
| `aictrl run <message>` | Execute a task headlessly |
90+
| `aictrl models` | List available models |
91+
| `aictrl mcp` | Manage MCP servers |
92+
| `aictrl session` | Manage sessions |
93+
| `aictrl upgrade` | Upgrade the CLI |
94+
| `aictrl pr` | PR workflow helpers |
95+
96+
## SDK
97+
98+
For programmatic use:
99+
100+
```typescript
101+
import { createAictrl } from "@aictrl/sdk"
102+
103+
const client = await createAictrl()
104+
```
105+
106+
## Monorepo
107+
108+
| Package | Description |
109+
|---------|-------------|
110+
| `@aictrl/cli` | The CLI and headless runtime |
111+
| `@aictrl/sdk` | Programmatic SDK for embedding |
112+
| `@aictrl/plugin` | Plugin authoring utilities |
113+
| `@aictrl/util` | Shared utilities |
114+
115+
## Development
116+
117+
```bash
118+
bun install
119+
bun run --conditions=browser packages/cli/src/index.ts
120+
```
121+
122+
Build platform binaries:
123+
124+
```bash
125+
cd packages/cli && bun run build --single
126+
```
127+
34128
## Attribution
35129

36-
Aictrl is a fork of the [OpenCode](https://opencode.ai) project by [anomalyco](https://github.com/anomalyco/opencode) and is licensed under the MIT License.
130+
Aictrl is a fork of the [OpenCode](https://opencode.ai) project and is licensed under the MIT License.
37131

38132
---
39-
© 2026 [aictrl.dev](https://aictrl.dev)
133+
[aictrl.dev](https://aictrl.dev)

‎packages/cli/src/cli/cmd/uninstall.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,6 @@ export const UninstallCommand = {
5252
}),
5353

5454
handler: async (args: UninstallArgs) => {
55-
UI.empty()
56-
UI.println(UI.logo(" "))
5755
UI.empty()
5856
prompts.intro("Uninstall Aictrl")
5957

‎packages/cli/src/cli/cmd/upgrade.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ export const UpgradeCommand = {
2020
})
2121
},
2222
handler: async (args: { target?: string; method?: string }) => {
23-
UI.empty()
24-
UI.println(UI.logo(" "))
2523
UI.empty()
2624
prompts.intro("Upgrade")
2725
const detectedMethod = await Installation.method()

‎packages/cli/src/cli/logo.ts‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎packages/cli/src/cli/ui.ts‎

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
import z from "zod"
22
import { EOL } from "os"
33
import { NamedError } from "@aictrl/util/error"
4-
import { logo as glyphs } from "./logo"
5-
64
export namespace UI {
75
export const CancelledError = NamedError.create("UICancelledError", z.void())
86

@@ -40,54 +38,6 @@ export namespace UI {
4038
blank = true
4139
}
4240

43-
export function logo(pad?: string) {
44-
const result: string[] = []
45-
const reset = "\x1b[0m"
46-
const left = {
47-
fg: Bun.color("gray", "ansi") ?? "",
48-
shadow: "\x1b[38;5;235m",
49-
bg: "\x1b[48;5;235m",
50-
}
51-
const right = {
52-
fg: reset,
53-
shadow: "\x1b[38;5;238m",
54-
bg: "\x1b[48;5;238m",
55-
}
56-
const gap = " "
57-
const draw = (line: string, fg: string, shadow: string, bg: string) => {
58-
const parts: string[] = []
59-
for (const char of line) {
60-
if (char === "_") {
61-
parts.push(bg, " ", reset)
62-
continue
63-
}
64-
if (char === "^") {
65-
parts.push(fg, bg, "▀", reset)
66-
continue
67-
}
68-
if (char === "~") {
69-
parts.push(shadow, "▀", reset)
70-
continue
71-
}
72-
if (char === " ") {
73-
parts.push(" ")
74-
continue
75-
}
76-
parts.push(fg, char, reset)
77-
}
78-
return parts.join("")
79-
}
80-
glyphs.left.forEach((row, index) => {
81-
if (pad) result.push(pad)
82-
result.push(draw(row, left.fg, left.shadow, left.bg))
83-
result.push(gap)
84-
const other = glyphs.right[index] ?? ""
85-
result.push(draw(other, right.fg, right.shadow, right.bg))
86-
result.push(EOL)
87-
})
88-
return result.join("").trimEnd()
89-
}
90-
9141
export async function input(prompt: string): Promise<string> {
9242
const readline = require("readline")
9343
const rl = readline.createInterface({

‎packages/cli/src/headless.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ let cli = yargs(hideBin(process.argv))
8484
process.stderr.write("Database migration complete." + EOL)
8585
}
8686
})
87-
.usage("\n" + UI.logo())
87+
.usage("")
8888
.command(AcpCommand)
8989
.command(McpCommand)
9090
.command(RunCommand)

‎packages/cli/src/index.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ let cli = yargs(hideBin(process.argv))
7070
})
7171

7272
process.env.AGENT = "1"
73-
process.env.OPENCODE = "1"
73+
process.env.AICTRL = "1"
74+
process.env.OPENCODE = "1" // compat with opencode-era tools
7475
process.env.AICTRL_PID = String(process.pid)
7576

7677
Log.Default.info("aictrl", {
@@ -115,7 +116,7 @@ let cli = yargs(hideBin(process.argv))
115116
process.stderr.write("Database migration complete." + EOL)
116117
}
117118
})
118-
.usage("\n" + UI.logo())
119+
.usage("")
119120
.completion("completion", "generate shell completion script")
120121
.command(AcpCommand)
121122
.command(McpCommand)

0 commit comments

Comments
 (0)