@funnycode/myclaude 0.1.3 → 0.1.4

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 (4) hide show
  1. package/README.md +151 -36
  2. package/README.zh-CN.md +150 -29
  3. package/dist/myclaude.js +2 -2
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # myclaude
1
+ # @funnycode/myclaude
2
2
 
3
3
  An open-source AI coding assistant in your terminal — powered by Claude.
4
4
 
@@ -6,46 +6,49 @@ An open-source AI coding assistant in your terminal — powered by Claude.
6
6
  npx @funnycode/myclaude
7
7
  ```
8
8
 
9
- Or install globally:
10
-
11
- ```bash
12
- npm install -g @thomaslwq/myclaude
13
- npx @thomaslwq/myclaude
14
- ```
15
-
16
9
  ---
17
10
 
18
11
  ## Features
19
12
 
20
- - **Natural Language Coding** — Write, refactor, debug, and explain code by chatting with AI
21
- - **Slash Commands** — 80+ built-in commands: `/commit`, `/review`, `/test`, `/doc`, and more
22
- - **Git Integration** — Automatic commit messages, PR creation, branch management
23
- - **MCP Support** — Extensible tool integrations via Model Context Protocol
24
- - **Plugin System** — Extend with community plugins
25
- - **Terminal UI** — Beautiful React Ink-based interface with syntax highlighting
13
+ - **AI Chat** — Code writing, refactoring, debugging, and explanation via natural language
14
+ - **80+ Slash Commands** — `/commit`, `/review`, `/test`, `/doc`, `/config`, `/doctor` and more
15
+ - **File Operations** — Edit, write, create, and search files with AI guidance
16
+ - **Git Integration** — Automatic commit messages, branch management, PR creation
17
+ - **MCP Support** — Model Context Protocol for extensible tool integrations
18
+ - **Plugin System** — Install and manage plugins from marketplaces
19
+ - **Agent Mode** — Multi-step autonomous task execution
20
+ - **Skills System** — Extend capabilities with reusable skills
21
+ - **Terminal UI** — React Ink-based interface with syntax highlighting, themes, and Vim mode
26
22
 
27
23
  ---
28
24
 
29
25
  ## Quick Start
30
26
 
31
- ### 1. Install
27
+ ### Prerequisites
28
+
29
+ - **Node.js >= 18** (works with Bun too)
30
+ - **Git** (for some features)
31
+ - **Anthropic API key** or compatible provider
32
+
33
+ ### Install & Run
32
34
 
33
35
  ```bash
34
- npm install -g @thomaslwq/myclaude
36
+ npx @funnycode/myclaude
35
37
  ```
36
38
 
37
- ### 2. Set your API key
39
+ Or install globally:
38
40
 
39
41
  ```bash
40
- export ANTHROPIC_API_KEY=sk-ant-...
41
- # Or use the myclaude alias:
42
- export MYCLAUDE_API_KEY=sk-ant-...
42
+ npm install -g @funnycode/myclaude
43
+ npx @funnycode/myclaude
43
44
  ```
44
45
 
45
- ### 3. Run
46
+ ### Set API Key
46
47
 
47
48
  ```bash
48
- myclaude
49
+ export ANTHROPIC_API_KEY=sk-ant-...
50
+ # Or use the myclaude alias:
51
+ export MYCLAUDE_API_KEY=sk-ant-...
49
52
  ```
50
53
 
51
54
  ---
@@ -53,31 +56,107 @@ myclaude
53
56
  ## Usage
54
57
 
55
58
  ```bash
56
- myclaude # Start interactive REPL
57
- myclaude -p "explain this project" # Run with a prompt
58
- myclaude --version # Show version
59
- myclaude --help # Show help
59
+ npx @funnycode/myclaude # Start interactive REPL
60
+ npx @funnycode/myclaude -p "explain this project" # Run with a prompt
61
+ npx @funnycode/myclaude --version # Show version
62
+ npx @funnycode/myclaude --help # Show help
60
63
  ```
61
64
 
62
- ### Common Commands
65
+ ---
66
+
67
+ ## Slash Commands
63
68
 
69
+ ### Core
64
70
  | Command | Description |
65
71
  |---------|-------------|
66
- | `/commit` | Generate a git commit message |
67
- | `/review` | Review code changes |
68
- | `/test` | Generate and run tests |
69
- | `/doc` | Generate documentation |
72
+ | `/help` | Show help |
73
+ | `/clear` | Clear conversation |
74
+ | `/exit` | Exit |
75
+ | `/resume` | Resume a previous session |
76
+ | `/rewind` | Rewind conversation |
77
+ | `/rename` | Rename current session |
70
78
  | `/config` | Configure settings |
71
- | `/doctor` | Diagnose installation |
79
+ | `/doctor` | Diagnose and verify installation |
80
+
81
+ ### Code & Git
82
+ | Command | Description |
83
+ |---------|-------------|
84
+ | `/commit` | Generate a git commit message |
85
+ | `/diff` | Show git diff |
86
+ | `/branch` | Switch/create branches |
87
+ | `/plan` | Create an implementation plan |
88
+
89
+ ### AI & Model
90
+ | Command | Description |
91
+ |---------|-------------|
72
92
  | `/model` | Change AI model |
73
- | `/clear` | Clear conversation |
74
- | `/cost` | Show usage statistics |
93
+ | `/effort` | Set effort level |
94
+ | `/fast` | Toggle fast mode |
95
+ | `/brief` | Toggle brief mode |
96
+ | `/output-style` | Set output style |
97
+
98
+ ### Files & Context
99
+ | Command | Description |
100
+ |---------|-------------|
101
+ | `/add-dir` | Add directory to context |
102
+ | `/context` | Show current context |
103
+ | `/files` | File operations |
104
+ | `/copy` | Copy content |
105
+
106
+ ### MCP & Plugins
107
+ | Command | Description |
108
+ |---------|-------------|
109
+ | `/mcp` | Manage MCP servers |
110
+ | `/plugin` | Manage plugins and marketplaces |
111
+ | `/reload-plugins` | Reload all plugins |
112
+ | `/hooks` | Manage hooks |
113
+
114
+ ### System
115
+ | Command | Description |
116
+ |---------|-------------|
117
+ | `/status` | Show authentication and session status |
118
+ | `/stats` | Show usage statistics |
119
+ | `/cost` | Show cost information |
120
+ | `/color` | Set color theme |
121
+ | `/theme` | Set UI theme |
122
+ | `/keybindings` | Configure keybindings |
123
+ | `/vim` | Toggle Vim mode |
124
+ | `/terminal-setup` | Terminal setup |
125
+ | `/memory` | Manage AI memory |
126
+ | `/skills` | Manage skills |
127
+ | `/sandbox` | Toggle sandbox mode |
128
+ | `/session` | Session management |
129
+ | `/tag` | Tag current session |
130
+ | `/export` | Export session |
131
+ | `/upgrade` | Check for updates |
132
+
133
+ ---
134
+
135
+ ## Verified Working Features
136
+
137
+ The following features have been tested and confirmed working:
138
+
139
+ - ✅ Interactive REPL (chat with AI)
140
+ - ✅ Print mode (`-p` flag)
141
+ - ✅ Model switching (`/model`)
142
+ - ✅ Slash commands (most)
143
+ - ✅ MCP server add/remove/list
144
+ - ✅ Plugin installation
145
+ - ✅ Git commit generation
146
+ - ✅ File editing and creation
147
+ - ✅ Skills system
148
+ - ✅ Vim mode
149
+ - ✅ Config management
150
+ - ✅ Doctor diagnostics
151
+ - ✅ Dark/light themes
152
+ - ✅ Keybinding customization
153
+ - ✅ API key authentication (with any Anthropic-compatible provider)
75
154
 
76
155
  ---
77
156
 
78
157
  ## Environment Variables
79
158
 
80
- You can use either `MYCLAUDE_*` or `CLAUDE_CODE_*` names.
159
+ Supports both `MYCLAUDE_*` and `CLAUDE_CODE_*` names.
81
160
  `CLAUDE_CODE_*` takes priority if both are set.
82
161
 
83
162
  | Variable | Description |
@@ -86,7 +165,7 @@ You can use either `MYCLAUDE_*` or `CLAUDE_CODE_*` names.
86
165
  | `ANTHROPIC_BASE_URL` / `MYCLAUDE_BASE_URL` | Custom API base URL |
87
166
  | `MYCLAUDE_MODEL` | Model override |
88
167
  | `MYCLAUDE_SIMPLE` | Simple mode (no TUI) |
89
- | `MYCLAUDE_BRIEF` | Brief mode (shorter output) |
168
+ | `MYCLAUDE_BRIEF` | Brief mode |
90
169
  | `MYCLAUDE_DISABLE_THINKING` | Disable thinking |
91
170
  | `MYCLAUDE_PROACTIVE` | Proactive mode |
92
171
  | `MYCLAUDE_USE_BEDROCK` | Use AWS Bedrock |
@@ -99,6 +178,42 @@ You can use either `MYCLAUDE_*` or `CLAUDE_CODE_*` names.
99
178
 
100
179
  ---
101
180
 
181
+ ## Contributing
182
+
183
+ Contributions via MR (Merge Request) are welcome!
184
+
185
+ ### Development
186
+
187
+ ```bash
188
+ git clone https://github.com/thomaslwq/myclaude.git
189
+ cd myclaude
190
+ bun install
191
+ bun run dev
192
+ ```
193
+
194
+ ### Build
195
+
196
+ ```bash
197
+ bun run build # Build to dist/myclaude.js
198
+ ```
199
+
200
+ ### Guidelines
201
+
202
+ - Fork the repo and create a feature branch
203
+ - Keep changes focused and minimal
204
+ - Test your changes before submitting
205
+ - Open a MR against the `main` branch
206
+
207
+ ---
208
+
209
+ ## Links
210
+
211
+ - **GitHub**: [https://github.com/thomaslwq/myclaude](https://github.com/thomaslwq/myclaude)
212
+ - **npm**: [https://www.npmjs.com/package/@funnycode/myclaude](https://www.npmjs.com/package/@funnycode/myclaude)
213
+ - **Gitee**: [https://gitee.com/thomaslwq/myclaude](https://gitee.com/thomaslwq/myclaude)
214
+
215
+ ---
216
+
102
217
  ## License
103
218
 
104
219
  MIT
package/README.zh-CN.md CHANGED
@@ -1,45 +1,54 @@
1
- # myclaude
1
+ # @funnycode/myclaude
2
2
 
3
3
  开源的 AI 编码助手，运行在你的终端中——由 Claude 驱动。
4
4
 
5
5
  ```bash
6
- npm install -g @funnycode/myclaude
7
- myclaude
6
+ npx @funnycode/myclaude
8
7
  ```
9
8
 
10
9
  ---
11
10
 
12
11
  ## 功能特性
13
12
 
14
- - **自然语言编程** — 通过对话编写、重构、调试和解释代码
15
- - **斜杠命令** — 80+ 内置命令：`/commit`、`/review`、`/test`、`/doc` 等
16
- - **Git 集成** — 自动生成提交信息、创建 PR、管理分支
17
- - **MCP 支持** — 通过 Model Context Protocol 扩展工具集成
18
- - **插件系统** — 社区插件扩展
19
- - **终端 UI** — 基于 React Ink 的界面，支持语法高亮
13
+ - **AI 对话** — 通过自然语言编写、重构、调试和解释代码
14
+ - **80+ 斜杠命令** — `/commit`、`/review`、`/test`、`/doc`、`/config`、`/doctor` 等
15
+ - **文件操作** — 在 AI 指导下编辑、写入、创建和搜索文件
16
+ - **Git 集成** — 自动生成提交信息、管理分支、创建 PR
17
+ - **MCP 支持** — Model Context Protocol 可扩展工具集成
18
+ - **插件系统** — 安装和管理市场插件
19
+ - **Agent 模式** — 多步自主任务执行
20
+ - **技能系统** — 通过可复用技能扩展能力
21
+ - **终端 UI** — React Ink 界面，支持语法高亮、主题和 Vim 模式
20
22
 
21
23
  ---
22
24
 
23
25
  ## 快速开始
24
26
 
25
- ### 1. 安装
27
+ ### 环境要求
28
+
29
+ - **Node.js >= 18**（也可以用 Bun）
30
+ - **Git**（部分功能需要）
31
+ - **Anthropic API 密钥** 或兼容的 AI 提供商
32
+
33
+ ### 安装运行
26
34
 
27
35
  ```bash
28
- npm install -g @funnycode/myclaude
36
+ npx @funnycode/myclaude
29
37
  ```
30
38
 
31
- ### 2. 设置 API Key
39
+ 或全局安装：
32
40
 
33
41
  ```bash
34
- export ANTHROPIC_API_KEY=sk-ant-...
35
- # 或使用 myclaude 别名：
36
- export MYCLAUDE_API_KEY=sk-ant-...
42
+ npm install -g @funnycode/myclaude
43
+ npx @funnycode/myclaude
37
44
  ```
38
45
 
39
- ### 3. 运行
46
+ ### 设置 API Key
40
47
 
41
48
  ```bash
42
- myclaude
49
+ export ANTHROPIC_API_KEY=sk-ant-...
50
+ # 或使用 myclaude 别名：
51
+ export MYCLAUDE_API_KEY=sk-ant-...
43
52
  ```
44
53
 
45
54
  ---
@@ -47,25 +56,101 @@ myclaude
47
56
  ## 使用方法
48
57
 
49
58
  ```bash
50
- myclaude # 启动交互式会话
51
- myclaude -p "解释这个项目" # 直接执行 prompt
52
- myclaude --version # 查看版本
53
- myclaude --help # 查看帮助
59
+ npx @funnycode/myclaude # 启动交互式会话
60
+ npx @funnycode/myclaude -p "解释这个项目" # 直接执行 prompt
61
+ npx @funnycode/myclaude --version # 查看版本
62
+ npx @funnycode/myclaude --help # 查看帮助
54
63
  ```
55
64
 
56
- ### 常用命令
65
+ ---
66
+
67
+ ## 斜杠命令
57
68
 
69
+ ### 核心
58
70
  | 命令 | 说明 |
59
71
  |------|------|
60
- | `/commit` | 生成 Git 提交信息 |
61
- | `/review` | 代码审查 |
62
- | `/test` | 生成和运行测试 |
63
- | `/doc` | 生成文档 |
72
+ | `/help` | 帮助 |
73
+ | `/clear` | 清除对话 |
74
+ | `/exit` | 退出 |
75
+ | `/resume` | 恢复之前的会话 |
76
+ | `/rewind` | 回退对话 |
77
+ | `/rename` | 重命名当前会话 |
64
78
  | `/config` | 配置设置 |
65
- | `/doctor` | 诊断安装 |
79
+ | `/doctor` | 诊断和验证安装 |
80
+
81
+ ### 代码和 Git
82
+ | 命令 | 说明 |
83
+ |------|------|
84
+ | `/commit` | 生成 Git 提交信息 |
85
+ | `/diff` | 查看 Git 差异 |
86
+ | `/branch` | 切换/创建分支 |
87
+ | `/plan` | 创建实施计划 |
88
+
89
+ ### AI 和模型
90
+ | 命令 | 说明 |
91
+ |------|------|
66
92
  | `/model` | 切换 AI 模型 |
67
- | `/clear` | 清除对话 |
68
- | `/cost` | 查看使用统计 |
93
+ | `/effort` | 设置努力级别 |
94
+ | `/fast` | 切换快速模式 |
95
+ | `/brief` | 切换简报模式 |
96
+ | `/output-style` | 设置输出风格 |
97
+
98
+ ### 文件和上下文
99
+ | 命令 | 说明 |
100
+ |------|------|
101
+ | `/add-dir` | 添加目录到上下文 |
102
+ | `/context` | 显示当前上下文 |
103
+ | `/files` | 文件操作 |
104
+ | `/copy` | 复制内容 |
105
+
106
+ ### MCP 和插件
107
+ | 命令 | 说明 |
108
+ |------|------|
109
+ | `/mcp` | 管理 MCP 服务器 |
110
+ | `/plugin` | 管理插件和市场 |
111
+ | `/reload-plugins` | 重新加载所有插件 |
112
+ | `/hooks` | 管理钩子 |
113
+
114
+ ### 系统
115
+ | 命令 | 说明 |
116
+ |------|------|
117
+ | `/status` | 显示认证和会话状态 |
118
+ | `/stats` | 显示使用统计 |
119
+ | `/cost` | 显示费用信息 |
120
+ | `/color` | 设置颜色主题 |
121
+ | `/theme` | 设置 UI 主题 |
122
+ | `/keybindings` | 配置按键绑定 |
123
+ | `/vim` | 切换 Vim 模式 |
124
+ | `/terminal-setup` | 终端设置 |
125
+ | `/memory` | 管理 AI 记忆 |
126
+ | `/skills` | 管理技能 |
127
+ | `/sandbox` | 切换沙盒模式 |
128
+ | `/session` | 会话管理 |
129
+ | `/tag` | 标记当前会话 |
130
+ | `/export` | 导出会话 |
131
+ | `/upgrade` | 检查更新 |
132
+
133
+ ---
134
+
135
+ ## 已确认可用的功能
136
+
137
+ 以下功能已经过测试并确认可用：
138
+
139
+ - ✅ 交互式 REPL（与 AI 对话）
140
+ - ✅ 打印模式（`-p` 参数）
141
+ - ✅ 模型切换（`/model`）
142
+ - ✅ 大部分斜杠命令
143
+ - ✅ MCP 服务器添加/删除/列表
144
+ - ✅ 插件安装
145
+ - ✅ Git 提交信息生成
146
+ - ✅ 文件编辑和创建
147
+ - ✅ 技能系统
148
+ - ✅ Vim 模式
149
+ - ✅ 配置管理
150
+ - ✅ Doctor 诊断
151
+ - ✅ 深色/浅色主题
152
+ - ✅ 按键绑定自定义
153
+ - ✅ API 密钥认证（兼容任何 Anthropic API 提供商）
69
154
 
70
155
  ---
71
156
 
@@ -93,6 +178,42 @@ myclaude --help # 查看帮助
93
178
 
94
179
  ---
95
180
 
181
+ ## 贡献
182
+
183
+ 欢迎提交 MR（Merge Request）参与贡献！
184
+
185
+ ### 开发
186
+
187
+ ```bash
188
+ git clone https://github.com/thomaslwq/myclaude.git
189
+ cd myclaude
190
+ bun install
191
+ bun run dev
192
+ ```
193
+
194
+ ### 构建
195
+
196
+ ```bash
197
+ bun run build # 构建到 dist/myclaude.js
198
+ ```
199
+
200
+ ### 指南
201
+
202
+ - Fork 仓库并创建功能分支
203
+ - 保持改动聚焦且最小化
204
+ - 提交前测试你的改动
205
+ - 向 `main` 分支发起 MR
206
+
207
+ ---
208
+
209
+ ## 相关链接
210
+
211
+ - **GitHub**: [https://github.com/thomaslwq/myclaude](https://github.com/thomaslwq/myclaude)
212
+ - **npm**: [https://www.npmjs.com/package/@funnycode/myclaude](https://www.npmjs.com/package/@funnycode/myclaude)
213
+ - **Gitee**: [https://gitee.com/thomaslwq/myclaude](https://gitee.com/thomaslwq/myclaude)
214
+
215
+ ---
216
+
96
217
  ## 许可证
97
218
 
98
219
  MIT
package/dist/myclaude.js CHANGED
@@ -4,8 +4,8 @@
4
4
  // MACRO - build-time constants (injected by build.ts)
5
5
  // MACRO injected by build script
6
6
  globalThis.MACRO = {
7
- VERSION: "0.1.3",
8
- BUILD_TIME: "2026-06-12T12:35:23.304Z",
7
+ VERSION: "0.1.4",
8
+ BUILD_TIME: "2026-06-12T12:49:57.867Z",
9
9
  PACKAGE_URL: "@funnycode/myclaude",
10
10
  NATIVE_PACKAGE_URL: "@funnycode/myclaude",
11
11
  VERSION_CHANGELOG: '',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@funnycode/myclaude",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "private": false,
5
5
  "description": "An open-source AI coding assistant in your terminal - powered by Claude",
6
6
  "license": "MIT",