Skip to content

Commit 6ad533d

Browse files
committed
docs(cli): refine published package copy
1 parent 04cf136 commit 6ad533d

2 files changed

Lines changed: 15 additions & 80 deletions

File tree

packages/cli/README.md

Lines changed: 14 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,35 @@
11
# @spencer-kit/coder-studio
22

3-
Coder Studio CLI - Agent-First Development Environment
3+
> Deploy once, code everywhere.
44
5-
## 安装
5+
Coder Studio is a browser-based AI coding workspace that lets you keep using the same local project, Agent sessions, files, Git, and terminal across devices.
66

7-
```bash
8-
npm install -g @spencer-kit/coder-studio
9-
```
7+
## What It Solves
108

11-
## 命令
9+
Typical AI coding workflows stay tied to the machine where the CLI is running. If you leave that device, it becomes harder to keep watching progress, reviewing diffs, or continuing the same workspace from somewhere else.
1210

13-
### serve / server
11+
Coder Studio turns that into a persistent workspace you can reopen from another computer, tablet, or phone without handing off the environment again.
1412

15-
启动 Coder Studio 服务器:
13+
## Install
1614

1715
```bash
18-
coder-studio serve [options]
19-
coder-studio server
16+
npm install -g @spencer-kit/coder-studio
2017
```
2118

22-
说明:
23-
- `serve` 默认以后台托管模式启动服务
24-
- `server``serve` 的别名
25-
- 如果当前已有服务在运行,会先提示是否重启
26-
- `serve --restart` 会直接重启当前托管服务,不再询问
27-
- `serve --foreground` 会以前台模式启动服务
28-
29-
### open
30-
31-
启动服务并直接打开浏览器:
19+
## Quick Start
3220

3321
```bash
3422
coder-studio open
3523
```
3624

37-
说明:
38-
- 如果服务未启动,会先启动再打开浏览器
39-
- 如果服务已启动,会提示是否重启
40-
- `open --restart` 会直接重启后再打开浏览器
41-
- 选择不重启时,会直接打开当前运行中的地址
42-
- 非交互场景下如果已有服务,不会自动重启,并会明确提示未重新启动
43-
44-
### status
45-
46-
查看当前托管服务状态:
47-
48-
```bash
49-
coder-studio status
50-
```
51-
52-
输出包含:
53-
- 当前状态
54-
- 监听 host / IP / port
55-
- 完整监听 URL
56-
- 本地访问 URL
57-
- PID、启动时间、重启次数、日志路径
58-
59-
### version
60-
61-
显示版本号:
62-
63-
```bash
64-
coder-studio version
65-
```
66-
67-
### help
68-
69-
显示帮助信息:
70-
71-
```bash
72-
coder-studio help
73-
```
74-
75-
## 配置
76-
77-
### 认证
78-
79-
默认情况下,服务不需要认证。启用认证:
80-
81-
```bash
82-
coder-studio config --password mypassword
83-
```
84-
85-
### 数据目录
86-
87-
指定数据存储位置:
88-
89-
```bash
90-
coder-studio config --data-dir /path/to/data
91-
```
25+
Then open a workspace in the browser and start a Claude or Codex session.
9226

93-
## Provider 支持
27+
## More Information
9428

95-
- **Claude** (Full mode) - 需要安装 Claude Code CLI
96-
- **Codex** (Limited mode) - 需要安装 Codex CLI
29+
- Full project README: https://github.com/spencerkit/coder-studio/blob/main/README.md
30+
- Chinese README: https://github.com/spencerkit/coder-studio/blob/main/README.zh-CN.md
31+
- Documentation: https://github.com/spencerkit/coder-studio/tree/main/docs/help
9732

98-
## 许可证
33+
## License
9934

10035
MIT

packages/cli/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@spencer-kit/coder-studio",
33
"version": "0.3.1",
44
"type": "module",
5-
"description": "Coder Studio CLI - The only published package",
5+
"description": "Deploy once, code everywhere. Browser-based AI coding workspace for Claude Code and Codex.",
66
"main": "./src/index.ts",
77
"bin": {
88
"coder-studio": "./src/bin.ts"

0 commit comments

Comments
 (0)