deplyze-code 0.1.0 → 0.1.1

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 (5) hide show
  1. package/README.en.md +77 -124
  2. package/README.md +78 -125
  3. package/bin/deplyze +2 -0
  4. package/package.json +11 -10
  5. package/preload.ts +1 -1
package/README.en.md CHANGED
@@ -2,209 +2,162 @@
2
2
 
3
3
  <p align="right"><a href="./README.md">中文</a> | <strong>English</strong></p>
4
4
 
5
- Deplyze Code is a Gemini-powered terminal coding assistant with the original-style Ink TUI and REPL preserved.
5
+ Deplyze Code is a Gemini-powered terminal coding assistant with an interactive Ink TUI, REPL, tools, and slash commands.
6
6
 
7
- > This repository keeps the working terminal UI and command flow intact while routing the active runtime through the Gemini API-key path.
7
+ This package is intended to be installed globally and started with:
8
8
 
9
- <p align="center">
10
- <img src="docs/00runtime.png" alt="Runtime screenshot" width="800">
11
- </p>
12
-
13
- ## Features
14
-
15
- - Full Ink TUI and interactive REPL
16
- - `--print` headless mode for scripts and CI
17
- - Slash commands, tools, MCP, plugins, and Skills
18
- - Gemini model switching through `/model`
19
- - Fallback Recovery CLI mode
9
+ ```bash
10
+ deplyze
11
+ ```
20
12
 
21
- ---
13
+ ## Status
22
14
 
23
- ## Quick Start
15
+ - Current private release: `0.1.1`
16
+ - Active auth path: Gemini API key
17
+ - Active model picker: Gemini 3.1 Pro, Gemini 3 Flash, Gemini 3.1 Flash-Lite
18
+ - `CLAUDE.md` remains the repository guidance filename for compatibility
24
19
 
25
- ### 1. Install Bun
20
+ ## Install
26
21
 
27
- This project requires [Bun](https://bun.sh).
22
+ Install Bun first if it is not already available:
28
23
 
29
24
  ```bash
30
- # macOS / Linux
31
25
  curl -fsSL https://bun.sh/install | bash
32
26
  ```
33
27
 
34
- ```bash
35
- # macOS (Homebrew)
36
- brew install bun
37
- ```
38
-
39
28
  ```powershell
40
- # Windows (PowerShell)
41
29
  powershell -c "irm bun.sh/install.ps1 | iex"
42
30
  ```
43
31
 
44
- Verify the installation:
45
-
46
- ```bash
47
- bun --version
48
- ```
49
-
50
- ### 2. Install Dependencies
32
+ Install the package globally:
51
33
 
52
34
  ```bash
53
- bun install
35
+ npm install -g deplyze-code
54
36
  ```
55
37
 
56
- ### 3. Configure Environment Variables
38
+ ## Required Environment Variable
57
39
 
58
- Copy the example file:
40
+ Set your Gemini API key:
59
41
 
60
42
  ```bash
61
- cp .env.example .env
43
+ export GEMINI_API_KEY="your_api_key_here"
62
44
  ```
63
45
 
64
- Set at least:
46
+ PowerShell:
65
47
 
66
- ```env
67
- GEMINI_API_KEY=your_api_key_here
48
+ ```powershell
49
+ $env:GEMINI_API_KEY="your_api_key_here"
68
50
  ```
69
51
 
70
52
  Optional:
71
53
 
72
- ```env
73
- GEMINI_MODEL=gemini-3.1-pro-preview
74
- GEMINI_SMALL_FAST_MODEL=gemini-3.1-flash-lite-preview
75
- DISABLE_TELEMETRY=1
76
- CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
54
+ ```bash
55
+ export GEMINI_MODEL="gemini-3.1-pro-preview"
56
+ export GEMINI_SMALL_FAST_MODEL="gemini-3.1-flash-lite-preview"
77
57
  ```
78
58
 
79
- ### 4. Run Locally From Source
59
+ ## Start
80
60
 
81
- #### macOS / Linux
61
+ Run:
82
62
 
83
63
  ```bash
84
- ./bin/deplyze
64
+ deplyze
85
65
  ```
86
66
 
87
- ```bash
88
- ./bin/deplyze -p "hello"
89
- ```
67
+ On first launch with `GEMINI_API_KEY` set, Deplyze Code should open directly into the main REPL without the legacy onboarding flow.
90
68
 
91
- ```bash
92
- echo "inspect this repository" | ./bin/deplyze -p
93
- ```
69
+ ## If `deplyze` Is Not Found
70
+
71
+ If global install succeeds but the shell says `deplyze` is not recognized, your npm global bin directory is probably not on `PATH`.
72
+
73
+ Check the prefix:
94
74
 
95
75
  ```bash
96
- ./bin/deplyze --help
76
+ npm prefix -g
97
77
  ```
98
78
 
99
- #### Windows
79
+ Make sure the corresponding global bin directory is on your shell `PATH`, then reopen the terminal.
100
80
 
101
- ```powershell
102
- bun ./bin/deplyze
103
- ```
81
+ ## Basic Usage
104
82
 
105
- ```powershell
106
- bun ./bin/deplyze -p "hello"
107
- ```
83
+ Plain interactive launch:
108
84
 
109
- ```powershell
110
- bun ./bin/deplyze --help
85
+ ```bash
86
+ deplyze
111
87
  ```
112
88
 
113
- ### 5. Install Globally
89
+ Single prompt:
114
90
 
115
91
  ```bash
116
- npm install -g deplyze-code
92
+ deplyze -p "hello"
117
93
  ```
118
94
 
119
- Then run:
95
+ Repository question:
120
96
 
121
97
  ```bash
122
- deplyze
98
+ deplyze -p "Inspect this repository and tell me what file launches the REPL."
123
99
  ```
124
100
 
125
- ---
101
+ Bash tool example:
126
102
 
127
- ## Environment Variables
103
+ ```bash
104
+ deplyze -p "Use the Bash tool to print the current working directory, then answer with only that path." --allowedTools Bash --dangerously-skip-permissions
105
+ ```
128
106
 
129
- | Variable | Required | Description |
130
- |------|------|------|
131
- | `GEMINI_API_KEY` | Yes | Gemini API key used by the normal interactive runtime |
132
- | `GEMINI_MODEL` | No | Default main model override |
133
- | `GEMINI_SMALL_FAST_MODEL` | No | Fast verification / low-cost model override |
134
- | `DISABLE_TELEMETRY` | No | Set to `1` to disable telemetry |
135
- | `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` | No | Set to `1` to disable non-essential network traffic |
107
+ ## Model Switching
136
108
 
137
- ---
109
+ Inside the interactive UI, run:
138
110
 
139
- ## Models
111
+ ```text
112
+ /model
113
+ ```
140
114
 
141
- The active `/model` flow exposes:
115
+ Available models in the active UI:
142
116
 
143
117
  - `Gemini 3.1 Pro`
144
118
  - `Gemini 3 Flash`
145
119
  - `Gemini 3.1 Flash-Lite`
146
120
 
147
- The runtime uses the current Gemini API handles underneath:
121
+ Underlying Gemini API model handles:
148
122
 
149
123
  - `gemini-3.1-pro-preview`
150
124
  - `gemini-3-flash-preview`
151
125
  - `gemini-3.1-flash-lite-preview`
152
126
 
153
- ---
127
+ ## What This Release Uses
128
+
129
+ - Provider flow: Gemini API key
130
+ - Required auth for normal usage: `GEMINI_API_KEY`
131
+ - UI flow: existing Deplyze Code TUI and REPL
132
+ - Legacy login and OAuth code still exists in the repository, but it is not required for the standard Gemini path
154
133
 
155
- ## Fallback Mode
134
+ ## Source Checkout Usage
156
135
 
157
- If the full TUI has issues, use the simplified recovery CLI:
136
+ If you are running from a local checkout instead of a global install:
158
137
 
159
138
  ```bash
160
- CLAUDE_CODE_FORCE_RECOVERY_CLI=1 ./bin/deplyze
139
+ bun install
140
+ ./bin/deplyze
161
141
  ```
162
142
 
163
- On Windows PowerShell:
143
+ Windows:
164
144
 
165
145
  ```powershell
166
- $env:CLAUDE_CODE_FORCE_RECOVERY_CLI='1'
146
+ bun install
167
147
  bun ./bin/deplyze
168
148
  ```
169
149
 
170
- ---
150
+ ## Recovery Mode
171
151
 
172
- ## Project Structure
152
+ If you need the simplified recovery CLI:
173
153
 
174
- ```text
175
- bin/deplyze # Release entry script
176
- preload.ts # Bun preload (sets MACRO globals)
177
- .env.example # Environment variable template
178
- src/
179
- ├── entrypoints/cli.tsx # Main CLI entry
180
- ├── main.tsx # Main TUI logic (Commander.js + React/Ink)
181
- ├── localRecoveryCli.ts # Fallback Recovery CLI
182
- ├── screens/REPL.tsx # Interactive REPL screen
183
- ├── components/ # UI components
184
- ├── commands/ # Slash commands
185
- ├── tools/ # Agent tools (Bash, Edit, Grep, etc.)
186
- ├── services/ # Service layer
187
- ├── hooks/ # React hooks
188
- └── utils/ # Utility functions
189
- ```
190
-
191
- ---
192
-
193
- ## Tech Stack
194
-
195
- | Category | Technology |
196
- |------|------|
197
- | Runtime | [Bun](https://bun.sh) |
198
- | Language | TypeScript |
199
- | Terminal UI | React + [Ink](https://github.com/vadimdemedes/ink) |
200
- | CLI parsing | Commander.js |
201
- | API | Gemini via [`@google/genai`](https://www.npmjs.com/package/@google/genai) |
202
- | Protocols | MCP, LSP |
203
-
204
- ---
205
-
206
- ## Notes
207
-
208
- - The active runtime uses API-key auth only for now.
209
- - Legacy login and onboarding code remains in the repository but is not required for normal Gemini usage.
210
- - The `CLAUDE.md` filename is intentionally unchanged for compatibility.
154
+ ```bash
155
+ CLAUDE_CODE_FORCE_RECOVERY_CLI=1 deplyze
156
+ ```
157
+
158
+ PowerShell:
159
+
160
+ ```powershell
161
+ $env:CLAUDE_CODE_FORCE_RECOVERY_CLI='1'
162
+ deplyze
163
+ ```
package/README.md CHANGED
@@ -2,209 +2,162 @@
2
2
 
3
3
  <p align="right"><strong>中文</strong> | <a href="./README.en.md">English</a></p>
4
4
 
5
- Deplyze Code 是一个基于 Gemini API Key 的终端编码助手，保留了原始风格的 Ink TUI 和 REPL 交互体验。
5
+ Deplyze Code 是一个基于 Gemini 的终端编码助手，提供交互式 Ink TUI、REPL、工具调用和斜杠命令。
6
6
 
7
- > 当前主流程已经切换到 Gemini API Key 运行路径，核心终端 UI、斜杠命令、工具调用和 `/model` 交互保持可用。
7
+ 当前推荐用法是全局安装后直接运行：
8
8
 
9
- <p align="center">
10
- <img src="docs/00runtime.png" alt="运行截图" width="800">
11
- </p>
12
-
13
- ## 功能
14
-
15
- - 完整的 Ink TUI 与交互式 REPL
16
- - `--print` 无头模式，适合脚本和 CI
17
- - 支持斜杠命令、工具、MCP、插件与 Skills
18
- - 支持通过 `/model` 切换 Gemini 模型
19
- - 保留简化版 Recovery CLI
9
+ ```bash
10
+ deplyze
11
+ ```
20
12
 
21
- ---
13
+ ## 当前状态
22
14
 
23
- ## 快速开始
15
+ - 当前私有发布版本：`0.1.1`
16
+ - 主认证路径：Gemini API Key
17
+ - 主模型菜单：Gemini 3.1 Pro、Gemini 3 Flash、Gemini 3.1 Flash-Lite
18
+ - 为兼容性保留 `CLAUDE.md` 文件名
24
19
 
25
- ### 1. 安装 Bun
20
+ ## 安装
26
21
 
27
- 本项目依赖 [Bun](https://bun.sh)。
22
+ 如果还没有 Bun，请先安装：
28
23
 
29
24
  ```bash
30
- # macOS / Linux
31
25
  curl -fsSL https://bun.sh/install | bash
32
26
  ```
33
27
 
34
- ```bash
35
- # macOS（Homebrew）
36
- brew install bun
37
- ```
38
-
39
28
  ```powershell
40
- # Windows（PowerShell）
41
29
  powershell -c "irm bun.sh/install.ps1 | iex"
42
30
  ```
43
31
 
44
- 安装完成后确认：
32
+ 然后全局安装：
45
33
 
46
34
  ```bash
47
- bun --version
48
- ```
49
-
50
- ### 2. 安装依赖
51
-
52
- ```bash
53
- bun install
35
+ npm install -g deplyze-code
54
36
  ```
55
37
 
56
- ### 3. 配置环境变量
38
+ ## 必需环境变量
57
39
 
58
- 复制示例文件：
40
+ 设置 Gemini API Key：
59
41
 
60
42
  ```bash
61
- cp .env.example .env
43
+ export GEMINI_API_KEY="your_api_key_here"
62
44
  ```
63
45
 
64
- 至少配置：
46
+ PowerShell：
65
47
 
66
- ```env
67
- GEMINI_API_KEY=your_api_key_here
48
+ ```powershell
49
+ $env:GEMINI_API_KEY="your_api_key_here"
68
50
  ```
69
51
 
70
- 可选配置：
52
+ 可选：
71
53
 
72
- ```env
73
- GEMINI_MODEL=gemini-3.1-pro-preview
74
- GEMINI_SMALL_FAST_MODEL=gemini-3.1-flash-lite-preview
75
- DISABLE_TELEMETRY=1
76
- CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
54
+ ```bash
55
+ export GEMINI_MODEL="gemini-3.1-pro-preview"
56
+ export GEMINI_SMALL_FAST_MODEL="gemini-3.1-flash-lite-preview"
77
57
  ```
78
58
 
79
- ### 4. 从源码启动
59
+ ## 启动
80
60
 
81
- #### macOS / Linux
61
+ 直接运行：
82
62
 
83
63
  ```bash
84
- ./bin/deplyze
64
+ deplyze
85
65
  ```
86
66
 
87
- ```bash
88
- ./bin/deplyze -p "hello"
89
- ```
67
+ 当 `GEMINI_API_KEY` 已设置时，首次启动应直接进入主 REPL，不再进入旧 onboarding 流程。
90
68
 
91
- ```bash
92
- echo "inspect this repository" | ./bin/deplyze -p
93
- ```
69
+ ## 如果提示找不到 `deplyze`
70
+
71
+ 如果全局安装成功，但终端提示 `deplyze` 无法识别，通常是 npm 全局 bin 目录没有加入 `PATH`。
72
+
73
+ 先查看前缀：
94
74
 
95
75
  ```bash
96
- ./bin/deplyze --help
76
+ npm prefix -g
97
77
  ```
98
78
 
99
- #### Windows
79
+ 确认对应的全局 bin 目录已经加入 shell 的 `PATH`，然后重新打开终端。
100
80
 
101
- ```powershell
102
- bun ./bin/deplyze
103
- ```
81
+ ## 基本用法
104
82
 
105
- ```powershell
106
- bun ./bin/deplyze -p "hello"
107
- ```
83
+ 交互模式：
108
84
 
109
- ```powershell
110
- bun ./bin/deplyze --help
85
+ ```bash
86
+ deplyze
111
87
  ```
112
88
 
113
- ### 5. 全局安装
89
+ 单次提问：
114
90
 
115
91
  ```bash
116
- npm install -g deplyze-code
92
+ deplyze -p "hello"
117
93
  ```
118
94
 
119
- 安装后直接运行：
95
+ 仓库问题示例：
120
96
 
121
97
  ```bash
122
- deplyze
98
+ deplyze -p "Inspect this repository and tell me what file launches the REPL."
123
99
  ```
124
100
 
125
- ---
101
+ Bash 工具示例：
126
102
 
127
- ## 环境变量
103
+ ```bash
104
+ deplyze -p "Use the Bash tool to print the current working directory, then answer with only that path." --allowedTools Bash --dangerously-skip-permissions
105
+ ```
128
106
 
129
- | 变量 | 必填 | 说明 |
130
- |------|------|------|
131
- | `GEMINI_API_KEY` | 是 | 主交互运行路径所需的 Gemini API Key |
132
- | `GEMINI_MODEL` | 否 | 默认主模型覆盖 |
133
- | `GEMINI_SMALL_FAST_MODEL` | 否 | 快速验证/低成本模型覆盖 |
134
- | `DISABLE_TELEMETRY` | 否 | 设为 `1` 可禁用遥测 |
135
- | `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` | 否 | 设为 `1` 可禁用非必要网络请求 |
107
+ ## 模型切换
136
108
 
137
- ---
109
+ 在交互界面中运行：
138
110
 
139
- ## 模型
111
+ ```text
112
+ /model
113
+ ```
140
114
 
141
- 当前 `/model` 主流程提供：
115
+ 当前主流程提供：
142
116
 
143
117
  - `Gemini 3.1 Pro`
144
118
  - `Gemini 3 Flash`
145
119
  - `Gemini 3.1 Flash-Lite`
146
120
 
147
- 运行时实际使用的 Gemini API 模型句柄为：
121
+ 底层实际使用的 Gemini API 模型句柄：
148
122
 
149
123
  - `gemini-3.1-pro-preview`
150
124
  - `gemini-3-flash-preview`
151
125
  - `gemini-3.1-flash-lite-preview`
152
126
 
153
- ---
127
+ ## 当前发布路径说明
154
128
 
155
- ## 降级模式
129
+ - Provider：Gemini API key
130
+ - 正常使用只需要：`GEMINI_API_KEY`
131
+ - 界面：沿用当前 Deplyze Code TUI 和 REPL
132
+ - 旧登录/OAuth 代码仍保留在仓库中，但标准 Gemini 主流程不依赖它
156
133
 
157
- 如果完整 TUI 异常，可以使用简化版 Recovery CLI：
134
+ ## 源码运行
135
+
136
+ 如果你是在本地源码目录中运行，而不是全局安装：
158
137
 
159
138
  ```bash
160
- CLAUDE_CODE_FORCE_RECOVERY_CLI=1 ./bin/deplyze
139
+ bun install
140
+ ./bin/deplyze
161
141
  ```
162
142
 
163
- PowerShell：
143
+ Windows：
164
144
 
165
145
  ```powershell
166
- $env:CLAUDE_CODE_FORCE_RECOVERY_CLI='1'
146
+ bun install
167
147
  bun ./bin/deplyze
168
148
  ```
169
149
 
170
- ---
150
+ ## Recovery 模式
171
151
 
172
- ## 项目结构
152
+ 如果需要简化版 recovery CLI：
173
153
 
174
- ```text
175
- bin/deplyze # 发布入口脚本
176
- preload.ts # Bun preload（设置 MACRO 全局变量）
177
- .env.example # 环境变量模板
178
- src/
179
- ├── entrypoints/cli.tsx # CLI 主入口
180
- ├── main.tsx # TUI 主逻辑（Commander.js + React/Ink）
181
- ├── localRecoveryCli.ts # Recovery CLI
182
- ├── screens/REPL.tsx # 交互式 REPL 界面
183
- ├── components/ # UI 组件
184
- ├── commands/ # 斜杠命令
185
- ├── tools/ # Agent 工具（Bash、Edit、Grep 等）
186
- ├── services/ # 服务层
187
- ├── hooks/ # React hooks
188
- └── utils/ # 工具函数
189
- ```
190
-
191
- ---
192
-
193
- ## 技术栈
194
-
195
- | 类别 | 技术 |
196
- |------|------|
197
- | 运行时 | [Bun](https://bun.sh) |
198
- | 语言 | TypeScript |
199
- | 终端 UI | React + [Ink](https://github.com/vadimdemedes/ink) |
200
- | CLI 解析 | Commander.js |
201
- | API | Gemini + [`@google/genai`](https://www.npmjs.com/package/@google/genai) |
202
- | 协议 | MCP, LSP |
203
-
204
- ---
205
-
206
- ## 说明
207
-
208
- - 当前主流程只要求 `GEMINI_API_KEY`。
209
- - 仓库中仍保留旧登录与旧 onboarding 代码，但正常 Gemini 使用不依赖它们。
210
- - `CLAUDE.md` 文件名出于兼容性考虑暂时保持不变。
154
+ ```bash
155
+ CLAUDE_CODE_FORCE_RECOVERY_CLI=1 deplyze
156
+ ```
157
+
158
+ PowerShell：
159
+
160
+ ```powershell
161
+ $env:CLAUDE_CODE_FORCE_RECOVERY_CLI='1'
162
+ deplyze
163
+ ```
package/bin/deplyze CHANGED
@@ -8,8 +8,10 @@ import { fileURLToPath } from 'node:url'
8
8
  const packageRoot = join(dirname(fileURLToPath(import.meta.url)), '..')
9
9
  const cwd = process.cwd()
10
10
  const envFile = join(cwd, '.env')
11
+ const preloadFile = join(packageRoot, 'preload.ts')
11
12
 
12
13
  const args: string[] = []
14
+ args.push(`--preload=${preloadFile}`)
13
15
  if (existsSync(envFile)) {
14
16
  args.push(`--env-file=${envFile}`)
15
17
  }
package/package.json CHANGED
@@ -1,14 +1,15 @@
1
1
  {
2
- "name": "deplyze-code",
3
- "version": "0.1.0",
4
- "type": "module",
5
- "bin": {
6
- "deplyze": "./bin/deplyze"
7
- },
8
- "scripts": {
9
- "deplyze": "bun run ./bin/deplyze",
10
- "start": "bun run ./bin/deplyze"
11
- },
2
+ "name": "deplyze-code",
3
+ "version": "0.1.1",
4
+ "description": "Deplyze Code is a Gemini-powered terminal coding assistant with an interactive Ink TUI.",
5
+ "type": "module",
6
+ "bin": {
7
+ "deplyze": "bin/deplyze"
8
+ },
9
+ "scripts": {
10
+ "deplyze": "bun run ./bin/deplyze",
11
+ "start": "bun run ./bin/deplyze"
12
+ },
12
13
  "dependencies": {
13
14
  "@anthropic-ai/sandbox-runtime": "^0.0.44",
14
15
  "@anthropic-ai/sdk": "^0.80.0",
package/preload.ts CHANGED
@@ -1,4 +1,4 @@
1
- const version = process.env.CLAUDE_CODE_LOCAL_VERSION ?? '0.1.0';
1
+ const version = process.env.CLAUDE_CODE_LOCAL_VERSION ?? '0.1.1';
2
2
  const packageUrl = process.env.CLAUDE_CODE_LOCAL_PACKAGE_URL ?? 'deplyze-code';
3
3
  const buildTime = process.env.CLAUDE_CODE_LOCAL_BUILD_TIME ?? new Date().toISOString();
4
4