Skip to content

docs(www): remove stale /status command docs #26

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

Merged
wynxing merged 1 commit into from
Apr 26, 2026
Merged

docs(www): remove stale /status command docs #26

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
18 changes: 9 additions & 9 deletions www/en/guide/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ go run ./cmd/neocode

## 3. Set API key

NeoCode reads API keys from environment variables — they are never written to config files.
NeoCode reads API keys from environment variables and never writes them to config files.

macOS / Linux:

Expand Down Expand Up @@ -66,17 +66,16 @@ Other providers:
neocode
```

You'll see the TUI interface. Type at the bottom to start a conversation.

To specify a workspace:
You will enter the TUI. Type in the input box at the bottom to start a conversation.
To open a specific workspace:

```bash
neocode --workdir /path/to/your/project
```

## 5. First conversation

Not sure what to ask? Try these:
Need a starting prompt? Try:

```text
Read the current project directory structure and give a module summary
Expand All @@ -86,19 +85,20 @@ Read the current project directory structure and give a module summary
Find the tool result injection logic in internal/runtime
```

The agent will automatically use file reading and search tools. When it requests file writes or command execution, the TUI will prompt for your approval.
The agent will use file reading and search tools automatically. When it needs to write files or run commands, the TUI will ask for approval.

## 6. Command cheat sheet
## 6. Common `/` commands

Inside the TUI, type `/` commands to perform operations:
Inside the TUI, use `/` commands for common actions:

| Command | Action |
|---|---|
| `/help` | Show all commands |
| `/provider` | Switch provider |
| `/provider add` | Add a custom provider |
| `/model` | Switch model |
| `/status` | Show current status |
| `/compact` | Compress long session context |
| `/clear` | Clear the current draft |
| `/cwd [path]` | View/switch workspace |
| `/session` | Switch session |
| `/memo` | View memory index |
Expand Down
16 changes: 8 additions & 8 deletions www/en/guide/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Common NeoCode issues and practical checks for startup, provider au

# Troubleshooting

This page is organized as: symptom -> likely causes -> 3-step checks.
This page follows: symptom -> likely causes -> 3-step checks.

## 1) `neocode` command not found

Expand Down Expand Up @@ -41,11 +41,11 @@ This page is organized as: symptom -> likely causes -> 3-step checks.
2. Check the env var mapping in [Configuration](./configuration).
3. Restart terminal, then launch `neocode` again.

## 3) Provider/model switch does not apply
## 3) Provider or model switch does not apply

### Symptom

- You switched provider/model but behavior still looks old.
- You switched provider or model, but behavior still looks unchanged.

### Likely causes

Expand All @@ -54,8 +54,8 @@ This page is organized as: symptom -> likely causes -> 3-step checks.

### 3-step checks

1. Reconfirm with `/provider` and `/model`.
2. Run `/status` to inspect current session state.
1. Reconfirm the current selection with `/provider` and `/model`.
2. Run `/compact` to reduce stale context impact in the current session.
3. Start a new session and retry the same prompt.

## 4) Too many permission prompts
Expand Down Expand Up @@ -89,9 +89,9 @@ This page is organized as: symptom -> likely causes -> 3-step checks.

### 3-step checks

1. Start `neocode gateway` separately and confirm it is healthy.
1. Start `neocode gateway` separately and confirm the process is running.
2. Verify minimal local path first on `127.0.0.1:8080`.
3. Review limits in [Gateway Usage](/guide/gateway).
3. Review auth and origin limits in [Gateway usage](./gateway).

## 6) Long sessions drift or degrade

Expand All @@ -114,4 +114,4 @@ This page is organized as: symptom -> likely causes -> 3-step checks.

- Return to [Getting Started](./) for a minimal path
- Daily operations: [Daily use](./daily-use)
- Gateway issues: [Gateway usage](/guide/gateway)
- Gateway issues: [Gateway usage](./gateway)
17 changes: 8 additions & 9 deletions www/guide/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ irm https://raw.githubusercontent.com/1024XEngineer/neo-code/main/scripts/instal

## 3. 设置 API Key

NeoCode 从环境变量读取 API Key，不会写入配置文件。
NeoCode 只从环境变量读取 API Key，不会写入配置文件。

macOS / Linux：

Expand Down Expand Up @@ -61,15 +61,15 @@ neocode

启动后你会看到 TUI 界面，底部是输入框，直接输入文字即可开始对话。

如果想指定工作区：
如果要直接打开指定工作区：

```bash
neocode --workdir /path/to/your/project
```

## 5. 第一次对话

不确定问什么？试试这两句：
不知道从哪里开始？可以先试这两句：

```text
请阅读当前项目目录结构，给出模块职责摘要
Expand All @@ -79,19 +79,18 @@ neocode --workdir /path/to/your/project
帮我在 internal/runtime 下定位与 tool result 回灌相关逻辑
```

Agent 会自动调用文件读取和搜索工具来完成任务。当它请求写入文件或执行命令时，TUI 会弹出权限确认——你确认后才执行。
Agent 会自动调用文件读取和搜索工具。当它需要写入文件或执行命令时，TUI 会先弹出权限确认。

## 6. 常用命令速查
## 6. 常用 `/` 命令

进入 TUI 后，输入 `/` 开头的命令可以执行操作：
进入 TUI 后，可用 `/` 命令执行常见操作：

| 命令 | 作用 |
|---|---|
| `/help` | 查看所有命令 |
| `/provider` | 切换 Provider |
| `/provider add` | 添加自定义 Provider |
| `/model` | 切换模型 |
| `/status` | 查看当前状态 |
| `/compact` | 压缩长会话上下文 |
| `/clear` | 清空当前草稿 |
| `/cwd [path]` | 查看/切换工作区 |
Expand All @@ -102,13 +101,13 @@ Agent 会自动调用文件读取和搜索工具来完成任务。当它请求
| `/skills` | 查看可用 Skills |
| `/exit` | 退出 |

## 装不上？
## 安装有问题？

看 [排障与常见问题](./troubleshooting)

## 开发者：从源码构建

如果你需要阅读代码、调试功能或参与开发，可以从源码构建运行。需要 Go 1.25+ 环境。
如果你要阅读代码、调试功能或参与开发，可以从源码构建运行。需要 Go 1.25+ 环境。

```bash
git clone https://github.com/1024XEngineer/neo-code.git
Expand Down
12 changes: 6 additions & 6 deletions www/guide/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: NeoCode 首次使用和日常使用中的高频问题排查清单

# 排障与常见问题

这页按“现象 -> 可能原因 -> 3 步排查”组织，优先解决首次使用中最常见的问题。
这页按“现象 -> 可能原因 -> 3 步排查”组织，优先覆盖首次使用和日常使用中最常见的问题。

## 1) 启动失败：`neocode` 命令不存在

Expand Down Expand Up @@ -41,11 +41,11 @@ description: NeoCode 首次使用和日常使用中的高频问题排查清单
2. 对照 [配置指南](./configuration) 的映射表，确认对应环境变量已设置。
3. 关闭并重新打开终端后再次启动 `neocode`。

## 3) 切换 Provider / Model 后不生效
## 3) 切换 Provider 或 Model 后不生效

### 现象

- 你已经切换了 Provider 或 Model，但请求仍像在走旧配置
- 你已经切换了 Provider 或 Model，但行为看起来仍在使用旧配置

### 可能原因

Expand All @@ -54,8 +54,8 @@ description: NeoCode 首次使用和日常使用中的高频问题排查清单

### 3 步排查

1. 在会话中执行 `/provider` 和 `/model` 再确认一次当前选择。
2. 执行 `/status` 查看当前会话状态。
1. 在会话中执行 `/provider` 和 `/model`，再确认一次当前选择。
2. 执行 `/compact`，减少旧上下文对当前会话的影响。
3. 新建会话后重试同一个请求，确认是否恢复正常。

## 4) 工具调用频繁被拦截或反复弹审批
Expand Down Expand Up @@ -91,7 +91,7 @@ description: NeoCode 首次使用和日常使用中的高频问题排查清单

### 3 步排查

1. 单独启动 `neocode gateway`，确认进程已正常运行。
1. 单独启动 `neocode gateway`，确认进程已经正常运行。
2. 使用默认本地监听地址 `127.0.0.1:8080` 先验证最小链路。
3. 对照 [Gateway 与 URL Dispatch](./gateway) 检查鉴权与来源限制。

Expand Down
Loading