Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 3.32 KB

File metadata and controls

115 lines (81 loc) · 3.32 KB
sidebar_position 2
title CLI 命令参考
description ReactPress CLI 完整命令参考 — init、doctor、logs、stop 及 Monorepo pnpm 脚本对照表。
keywords
reactpress
cli
commands
init
doctor
logs
pnpm

CLI 命令参考

ReactPress 有两套命令界面:全局 CLI(终端用户)与 Monorepo pnpm 脚本(贡献者)。

全局 CLI(@fecommunity/reactpress)

4.0 面向终端用户精简为以下命令;devthemeplugin 等旧命令已移除,请使用 Admin 或 Monorepo 脚本。

reactpress init [directory]

初始化站点并自动启动全栈服务。

选项 说明
-f, --force 强制重新初始化(清除本地数据)
mkdir my-site && cd my-site
reactpress init

reactpress doctor [directory]

诊断 Node 版本、端口占用、数据库连接、进程状态。

选项 说明
--show-logs 诊断失败时附加最近日志

子命令 reactpress doctor check 为默认行为。

reactpress logs [directory]

查看 API 结构化日志。

选项 说明
-f, --follow 持续跟踪
--tail <n> 显示最近 n 行(默认 50)
--source <name> 按来源过滤
--grep <pattern> 正则过滤
--list 列出可用日志源

别名:reactpress doctor logs

reactpress stop [directory]

停止当前项目的 API 与主题进程。

帮助与版本

reactpress           # 显示 banner + 帮助
reactpress --help
reactpress --version

Monorepo 脚本(仓库根目录)

贡献者与需要完整生命周期管理的部署场景:

脚本 说明
pnpm dev 全栈开发(API + Admin + Theme)
pnpm dev:api 仅 API
pnpm dev:web 仅 Admin + API
pnpm dev:client 仅访客主题
pnpm dev:desktop Electron 桌面开发
pnpm dev:docs 文档站 Docusaurus
pnpm build 生产构建
pnpm start / pnpm pm2 生产启动
pnpm build:plugins 编译官方插件
pnpm build:desktop 打包桌面安装程序
pnpm status 服务状态
pnpm run init 仅准备配置,不启动

Docker 相关(可选 MySQL)

脚本 说明
pnpm docker:dev 启动嵌入式 MySQL
pnpm docker:dev:stop 停止 Docker 数据库

环境变量

变量 说明 默认
REACTPRESS_LANG CLI / Admin 语言 en | zh en
DB_TYPE sqlite | mysql 配置 sqlite
SERVER_PORT API 端口 3002
CLIENT_SITE_URL 访客站公网 URL http://localhost:3001
ADMIN_USER / ADMIN_PASSWD 首次 bootstrap 管理员 admin / admin

完整列表见 项目配置项术语表

已废弃命令

以下命令在 4.0 全局 CLI 中会报错并提示使用 init

start · dev · docker · nginx · server · build · status · publish · theme · plugin · db · desktop · client

Monorepo 内 pnpm dev 等仍通过内部 CLI 入口调用完整实现。

相关文档