@cdoing/opentuicli 0.1.20 → 0.1.21

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.
Files changed (2) hide show
  1. package/README.md +12 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -5,12 +5,20 @@
5
5
 
6
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
7
 
8
+ ## Requirements
9
+
10
+ **[Bun](https://bun.sh) is required.** This package uses the OpenTUI framework which relies on Bun-native terminal rendering APIs and does not work with Node.js.
11
+
12
+ If you need Node.js compatibility, use [`@cdoing/cli`](https://www.npmjs.com/package/@cdoing/cli) instead (same agent, Ink-based UI).
13
+
8
14
  ## Installation
9
15
 
10
16
  ```bash
11
- npm install -g @cdoing/opentuicli
12
- # or
13
- yarn global add @cdoing/opentuicli
17
+ # Bun (required)
18
+ bun install -g @cdoing/opentuicli
19
+
20
+ # Install Bun if you don't have it
21
+ curl -fsSL https://bun.sh/install | bash
14
22
  ```
15
23
 
16
24
  ## Quick Start
@@ -32,6 +40,7 @@ This is the **lightweight alternative** to `@cdoing/cli`. While the main CLI use
32
40
 
33
41
  | | `@cdoing/cli` | `@cdoing/opentuicli` |
34
42
  |---|---|---|
43
+ | **Runtime** | Node.js (npm/yarn/pnpm) | **Bun only** |
35
44
  | **UI Framework** | Ink + React | OpenTUI |
36
45
  | **Bundle size** | Larger | Smaller |
37
46
  | **Startup time** | ~1s | ~0.5s |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cdoing/opentuicli",
3
- "version": "0.1.20",
3
+ "version": "0.1.21",
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",