跳到主要内容

SkillFlaw CLI

SkillFlaw CLI 是在 Python 环境中运行应用的主要命令行入口。

CLI 入口方式

你可以通过以下方式调用:


_10
uv run skillflaw --help

或者:


_10
python -m skillflaw --help

如果你在源码工作区中工作,通常更推荐配合 Makefile 包装命令一起使用,例如:make run_climake run_clicmake backendmake backend_start

当前可用的顶层命令

根据当前 CLI 的帮助输出,顶层命令包括:

  • run:启动 SkillFlaw
  • superuser:创建超级用户
  • copy-db:复制数据库文件到当前目录
  • migration:测试或执行数据库迁移
  • api-key:提示未认证 CLI API key 创建已不再支持
  • lfx:SkillFlaw Executor 相关命令

启动 SkillFlaw

最常见的命令是:


_10
uv run skillflaw run

如果你在源码工作区中开发,通常可直接用:


_10
make run_cli
_10
make run_clic

其中 make run_clic 更适合需要强制前端全量重建的场景。

常用 run 参数

当前 python -m skillflaw run --help 中最常用的参数包括:

参数说明
--host服务绑定地址
--port监听端口
--workersWorker 进程数
--worker-timeoutWorker 超时时间(秒)
--env-file.env 文件路径
--frontend-path前端构建产物路径
--components-path自定义组件目录
--log-level日志级别
--log-file日志文件路径
--cache缓存后端类型
--dev / --no-dev是否启用开发模式
--open-browser / --no-open-browser是否启动后自动打开浏览器
--backend-only / --no-backend-only是否仅运行后端
--auto-saving / --no-auto-saving是否启用自动保存
--auto-saving-interval自动保存防抖间隔
--max-file-size-upload上传文件大小上限(MB)
--ssl-cert-file-pathSSL 证书路径
--ssl-key-file-pathSSL 私钥路径

示例:


_10
uv run skillflaw run --env-file .env --host 0.0.0.0 --port 7860 --no-open-browser

通用参数

所有顶层命令都支持:

  • --version / -v
  • --install-completion
  • --show-completion
  • --help

其他重要子命令

skillflaw superuser

当启用了 CLI 超级用户创建能力时,可使用该命令在终端中创建超级用户。


_10
uv run skillflaw superuser --username admin --password 'your-password'

该命令受 SKILLFLAW_ENABLE_SUPERUSER_CLI 控制。

skillflaw migration

该命令用于预览或执行数据库 schema 迁移:


_10
uv run skillflaw migration
_10
uv run skillflaw migration --fix

建议先执行预览命令,确认输出后再决定是否执行 --fix

skillflaw api-key

该命令当前仅用于提示:未认证的 CLI API key 创建能力已不再支持。 如需创建 API key,请通过已认证的产品界面完成。

相关文档