Skip to content

Commit 0c1602b

Browse files
author
赵明俊
committed
docs: refresh Python release documentation
1 parent cf084c5 commit 0c1602b

22 files changed

Lines changed: 834 additions & 1033 deletions

.env.backup

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# =============================================================================
22
# Secbot 环境变量参考(可选 · 非发布后的必经步骤)
33
# -----------------------------------------------------------------------------
4-
# 复制为 .env 仅在你需要:无界面运行、CI/CD、容器固定默认值、或显式覆盖某次进程环境。
4+
# 复制为 .env 仅在你需要:无界面运行、CI/CD、无人值守服务固定默认值、或显式覆盖某次进程环境。
55
#
66
# 配置真源(发布后用户侧「应持久化」的常量)
77
# -----------------------------------------------------------------------------

AGENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Secbot / Hackbot 是一个以 **Python FastAPI 后端** 为核心的 AI 自动
143143
- 默认启动交互 CLI
144144
- `secbot_cli/cli.py`
145145
- 包安装后的 CLI 入口
146-
- `--backend` / `model` 子命令都在这里处理
146+
- `server` / `model` / `version` 子命令都在这里处理
147147
- `router/main.py`
148148
- FastAPI app 工厂
149149
- 注册所有路由

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ uv pip install -e .
6060

6161
### 1. Configure model backend (persistent)
6262

63-
You can start with **no** `.env`: run `secbot` and use `/model` (interactive) or `secbot model` to set provider, API keys, and defaults—these are **saved to SQLite** and used on next launch. Use a `.env` file only for CI, containers, or non-interactive defaults.
63+
You can start with **no** `.env`: run `secbot` and use `/model` (interactive) or `secbot model` to set provider, API keys, and defaults—these are **saved to SQLite** and used on next launch. Use a `.env` file only for CI, unattended runs, or non-interactive defaults.
6464

6565
Optional `.env` example:
6666

README_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ uv pip install -e .
6262

6363
### 1. 配置模型后端(持久化)
6464

65-
**可以不创建 `.env` 先发起来**:运行 `secbot`,在交互里用 `/model` 或执行 `secbot model` 设置厂商、密钥与默认模型——会**写入 SQLite**,下次启动优先使用。仅在 CI、容器或无界面场景需要时,再用 `.env` 提供默认或覆盖。
65+
**可以不创建 `.env` 先发起来**:运行 `secbot`,在交互里用 `/model` 或执行 `secbot model` 设置厂商、密钥与默认模型——会**写入 SQLite**,下次启动优先使用。仅在 CI、无人值守或无界面场景需要时,再用 `.env` 提供默认或覆盖。
6666

6767
可选 `.env` 示例:
6868

README_EN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ After install, the console command is **`secbot`** (a `hackbot` alias may also b
6262

6363
### 1. Configure model backend (persistent)
6464

65-
You can start **without** a `.env`: run `secbot`, then use `/model` in interactive mode or `secbot model` to set provider, API keys, and defaults—they are **stored in SQLite** and picked up on the next launch. Use `.env` only for CI, containers, or unattended defaults.
65+
You can start **without** a `.env`: run `secbot`, then use `/model` in interactive mode or `secbot model` to set provider, API keys, and defaults—they are **stored in SQLite** and picked up on the next launch. Use `.env` only for CI, unattended runs, or non-interactive defaults.
6666

6767
Optional `.env` example:
6868

docs/API.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
### 启动后端
88

99
```bash
10-
uv run secbot --backend
10+
secbot server
11+
# 或源码仓中
12+
uv run secbot server
1113
#
1214
python -m router.main
1315
```

0 commit comments

Comments
 (0)