@cdoing/opentuicli 0.1.2 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +91 -0
- package/package.json +5 -4
package/README.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# @cdoing/opentuicli
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@cdoing/opentuicli)
|
|
4
|
+
[](https://github.com/awaisshah228/cdoing-agent/blob/main/LICENSE)
|
|
5
|
+
|
|
6
|
+
Lightweight terminal interface for [Cdoing Agent](https://github.com/awaisshah228/cdoing-agent) — built on the OpenTUI framework. An open-source, multi-provider AI coding assistant.
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install -g @cdoing/opentuicli
|
|
12
|
+
# or
|
|
13
|
+
yarn global add @cdoing/opentuicli
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Quick Start
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Launch the TUI
|
|
20
|
+
cdoing-tui
|
|
21
|
+
|
|
22
|
+
# With a direct prompt
|
|
23
|
+
cdoing-tui "refactor this function to use async/await"
|
|
24
|
+
|
|
25
|
+
# With specific provider
|
|
26
|
+
cdoing-tui --provider openrouter --model anthropic/claude-sonnet-4
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Why OpenTUI?
|
|
30
|
+
|
|
31
|
+
This is the **lightweight alternative** to `@cdoing/cli`. While the main CLI uses Ink + React for a rich terminal UI, this package uses the OpenTUI framework for a minimal, fast, keyboard-driven experience.
|
|
32
|
+
|
|
33
|
+
| | `@cdoing/cli` | `@cdoing/opentuicli` |
|
|
34
|
+
|---|---|---|
|
|
35
|
+
| **UI Framework** | Ink + React | OpenTUI |
|
|
36
|
+
| **Bundle size** | Larger | Smaller |
|
|
37
|
+
| **Startup time** | ~1s | ~0.5s |
|
|
38
|
+
| **Features** | Full (tabs, history) | Essential |
|
|
39
|
+
| **Best for** | Daily use | Quick tasks, low-resource |
|
|
40
|
+
|
|
41
|
+
Both share the same **@cdoing/core** (20 tools, permissions, sandbox) and **@cdoing/ai** (multi-provider agent runner).
|
|
42
|
+
|
|
43
|
+
## Features
|
|
44
|
+
|
|
45
|
+
- **Multi-provider** — Anthropic, OpenAI, Google, Ollama, OpenRouter, Groq, Mistral, xAI, and any OpenAI-compatible API
|
|
46
|
+
- **20 built-in tools** — file read/write/edit, shell exec, search, web fetch, sub-agents
|
|
47
|
+
- **Real-time streaming** — token-by-token output
|
|
48
|
+
- **Context providers** — `@terminal`, `@tree`, `@url`, `@codebase`, `@git`, `@diff`
|
|
49
|
+
- **Permission system** — 5 modes with deny/allow/ask rules
|
|
50
|
+
- **Sandbox** — filesystem and network restrictions
|
|
51
|
+
- **Background processes** — run servers/watchers with status tracking
|
|
52
|
+
- **Smart output** — auto-truncates verbose output to save tokens
|
|
53
|
+
- **OAuth** — sign in with Claude Pro/Max account
|
|
54
|
+
- **Keyboard-driven** — fast, minimal interface
|
|
55
|
+
|
|
56
|
+
## Authentication
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# Environment variable
|
|
60
|
+
export ANTHROPIC_API_KEY=sk-ant-...
|
|
61
|
+
export OPENROUTER_API_KEY=sk-or-...
|
|
62
|
+
|
|
63
|
+
# Or use the setup wizard
|
|
64
|
+
cdoing-tui # Triggers setup on first run
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Supported Providers
|
|
68
|
+
|
|
69
|
+
| Provider | Default Model | Auth |
|
|
70
|
+
|----------|--------------|------|
|
|
71
|
+
| Anthropic | claude-sonnet-4-6 | API key / OAuth |
|
|
72
|
+
| OpenAI | gpt-4o | API key |
|
|
73
|
+
| Google | gemini-2.0-flash | API key |
|
|
74
|
+
| OpenRouter | anthropic/claude-sonnet-4 | API key |
|
|
75
|
+
| Ollama | llama3.1 | Not required |
|
|
76
|
+
| Groq | llama-3.3-70b-versatile | API key |
|
|
77
|
+
| Mistral | mistral-large-latest | API key |
|
|
78
|
+
| xAI | grok-3 | API key |
|
|
79
|
+
| Custom | — | Configurable |
|
|
80
|
+
|
|
81
|
+
## Related Packages
|
|
82
|
+
|
|
83
|
+
- **[@cdoing/cli](https://www.npmjs.com/package/@cdoing/cli)** — Full-featured Ink + React CLI
|
|
84
|
+
- **[VS Code Extension](https://marketplace.visualstudio.com/items?itemName=awaisshah228.cdoing-vscode)** — AI sidebar for VS Code
|
|
85
|
+
- **[@cdoing/core](https://www.npmjs.com/package/@cdoing/core)** — Core tools, permissions, sandbox
|
|
86
|
+
- **[@cdoing/ai](https://www.npmjs.com/package/@cdoing/ai)** — Agent runner, LLM providers
|
|
87
|
+
- **[GitHub](https://github.com/awaisshah228/cdoing-agent)** — Full monorepo
|
|
88
|
+
|
|
89
|
+
## License
|
|
90
|
+
|
|
91
|
+
Apache-2.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cdoing/opentuicli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.6",
|
|
4
4
|
"description": "OpenTUI-based terminal interface for cdoing agent (inspired by opencode's TUI)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -16,8 +16,8 @@
|
|
|
16
16
|
"clean": "rm -rf dist"
|
|
17
17
|
},
|
|
18
18
|
"dependencies": {
|
|
19
|
-
"@cdoing/ai": "
|
|
20
|
-
"@cdoing/core": "
|
|
19
|
+
"@cdoing/ai": "0.1.5",
|
|
20
|
+
"@cdoing/core": "0.1.8",
|
|
21
21
|
"@opentui/core": "0.1.87",
|
|
22
22
|
"@opentui/react": "0.1.87",
|
|
23
23
|
"chalk": "^4.1.2",
|
|
@@ -30,5 +30,6 @@
|
|
|
30
30
|
"esbuild": "^0.25.0",
|
|
31
31
|
"ts-node": "^10.9.2",
|
|
32
32
|
"typescript": "^5.8.2"
|
|
33
|
-
}
|
|
33
|
+
},
|
|
34
|
+
"license": "Apache-2.0"
|
|
34
35
|
}
|