Skip to content

docs(cli): sync English and Chinese guides #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wananing wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −8
Open

docs(cli): sync English and Chinese guides #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/en/guides/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Features:

## Command reference

> Convention: `retrieve` / `overview` / `lint` print human-readable rich text by default (add `--json` for machine output), and `sync` / `skill-export` print rich panels. All other commands print **JSON** to stdout.
> Convention: `retrieve` / `overview` / `lint` print human-readable rich text by default (add `--json` for machine output), and `sync` / `skill-export` print rich panels. Server/process commands such as `daemon` and `desktop-server` print status logs; most other data commands print **JSON** to stdout.

### Write & retrieve

Expand Down Expand Up @@ -250,12 +250,14 @@ contextseek skill-export --scope me/work --out ~/.contextseek/skills --dry-run

### Ops

| Command | Description |
|---------|-------------|
| `metrics` | Print Prometheus-format metrics |
| Command | Key args | Description |
|---------|----------|-------------|
| `metrics` | — | Print Prometheus-format metrics |
| `desktop-server` | `--host` `--port` `--data-dir` `--log-level` | Run the same-origin backend for the desktop app: HTTP API plus the built dashboard SPA |

```bash
contextseek metrics
contextseek desktop-server --host 127.0.0.1 --port 8000
```

---
Expand Down
10 changes: 6 additions & 4 deletions docs/zh/guides/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ sync 会跳过写入时的冲突检测以保证批量导入速度；导入后用

## 命令全表

> 约定：除 `retrieve` / `overview` / `lint` 默认输出人类可读的富文本（可加 `--json` 切机器格式）、`sync` / `skill-export` 输出富文本面板外，其余命令均向 stdout 打印 **JSON**。
> 约定：`retrieve` / `overview` / `lint` 默认输出人类可读的富文本（可加 `--json` 切机器格式），`sync` / `skill-export` 输出富文本面板。`daemon`、`desktop-server` 等服务 / 进程类命令输出状态日志；多数其它数据命令向 stdout 打印 **JSON**。

### 写入与检索

Expand Down Expand Up @@ -250,12 +250,14 @@ contextseek skill-export --scope me/work --out ~/.contextseek/skills --dry-run

### 运维

| 命令 | 说明 |
|------|------|
| `metrics` | 打印 Prometheus 文本格式指标 |
| 命令 | 关键参数 | 说明 |
|------|----------|------|
| `metrics` | — | 打印 Prometheus 文本格式指标 |
| `desktop-server` | `--host` `--port` `--data-dir` `--log-level` | 为桌面端运行同源后端：HTTP API 与已构建的 dashboard SPA |

```bash
contextseek metrics
contextseek desktop-server --host 127.0.0.1 --port 8000
```

---
Expand Down
Loading