命令行参考

除非另有说明，以下命令都在仓库根目录运行。

start.py：从源码启动

python start.py [--desktop] [--check | --prepare-only] [--data-dir DIR] [--port PORT] [--host HOST] [--admin-user NAME] [--no-browser] [--password-stdin]

选项	默认值	含义
--data-dir	各系统的默认目录（见数据、备份与升级）	新的空目录，或由本启动器创建过的目录
--port	18989	HTTP 端口
--host	只绑定本机	绑定地址。填局域网 IP 会以 HTTP 明文开放到你的网络
--desktop	关闭	同时安装并打开桌面客户端，使用单独的配置目录
--check		只检查环境，不安装、不改动文件
--prepare-only		安装依赖并构建界面，不启动服务，也不要求设置密码
--admin-user	admin	首次启动时的管理员账号名
--no-browser		不打开浏览器
--password-stdin		从标准输入读取首次管理员密码，不从参数或文件读取

其他入口：sh start.sh；Windows 的 start.cmd 和 start-desktop.cmd（相当于加了 --desktop）；macOS 的 start.command 和 start-desktop.command。

ops/self-host/deploy.py：单机 Docker

python ops/self-host/deploy.py [up|status|logs|stop|credentials] [--data-dir DIR] [--port PORT] [--public-url URL] [--no-build]

命令	含义
up	需要时构建并启动。首次运行会创建私有配置
status	容器状态
logs	日志
stop	停止这个实例，数据、文件和密钥都保留
credentials	显示首次启动时的管理员密码

选项	含义
--data-dir	实例目录，之后每条命令都要用同一个
--port	只在首次初始化时生效，默认 18989
--public-url	反向代理的 HTTPS 源地址
--no-build	用已构建的镜像执行 up

其他入口：ops/self-host/deploy.cmd、sh ops/self-host/deploy.sh。

runner_main.py：独立执行机

通常由接入指令安装（见 Runner 与云端环境）。选项：

选项	环境变量
--hub	SODUWORK_HUB
--key	SODUWORK_RUNNER_KEY
--id	SODUWORK_RUNNER_ID
--tags	SODUWORK_RUNNER_TAGS
--work-root	SODUWORK_WORK_ROOT
--data-root	SODUWORK_DATA_ROOT
--max-concurrent	SODUWORK_RUNNER_MAX_CONCURRENT
--doctor

检查命令

位置	命令
仓库根目录	python -m unittest tools.dev.test_start_local、node tools/check-public-source.cjs、node tools/check-repository-layout.cjs、node tools/check-third-party.cjs、node tools/check-docs.cjs、python tools/security/scan_secrets.py --download
client/	npm test、npm run check:layout
hub-frontend/	node --test tests/*.test.mjs、npm run build
hub-backend/	python quality_gate.py --profile release --scope backend；--list 列出全部门禁
启动器测试	python -m unittest tools.dev.test_start_local tools.dev.test_deploy