跳转到内容
StudioCMS 文档
主站点

命令行工具集

StudioCMS CLI 工具集提供快速创建项目和实用功能操作能力，包含三个核心工具：

studiocms

Section titled “studiocms”

完整命令选项

Section titled “完整命令选项”
用法: studiocms [选项] [命令]


选项:
  -V, --version   显示当前CLI版本
  -h, --help      显示命令帮助
  --color         强制启用彩色输出
  --no-color      禁用彩色输出


命令:
  add             添加插件
  crypto          安全加密工具
  get-turso       安装Turso CLI
  init            初始化StudioCMS项目
  users           用户管理工具

使用示例

Section titled “使用示例”

在项目根目录执行：

Terminal window
npm run studiocms [command]

命令详解

Section titled “命令详解”

add

Section titled “add”
用法: studiocms add <插件名...>


安装StudioCMS插件到当前项目


参数:
  plugins    要安装的插件列表


选项:
  -h, --help  显示帮助信息

crypto

Section titled “crypto”
用法: studiocms crypto [命令]


安全加密工具集


选项:
  -h, --help  显示帮助信息


子命令:
  gen-jwt     生成JWT令牌

crypto gen-jwt

Section titled “crypto gen-jwt”
用法: studiocms crypto gen-jwt [选项] <密钥文件>


根据PEM密钥文件生成JWT令牌


参数:
  key-file       PEM密钥文件相对路径 (如: `../keys/libsql.pem`)


选项:
  -e, --exp <有效期秒数>  相对签发时间(iat)的有效期 (>=0)
  -h, --help             显示帮助信息

get-turso

Section titled “get-turso”

下载并安装最新版 Turso CLI^

:::caution 注意 Windows 系统需使用 WSL 环境 :::

用法: getTurso [选项]


Turso CLI 安装器


选项:
  -h, --help  显示帮助信息

init

Section titled “init”
用法: studiocms init [选项]


初始化新安装的StudioCMS项目


选项:
  -d, --dry-run      模拟运行模式
  --skip-banners     跳过引导提示
  --debug            启用调试模式
  -h, --help         显示帮助信息

初始化命令提供交互式设置引导，协助您：

  1. 配置环境文件 (.env)：

    • 可基于模板创建
    • 支持交互式配置：
      • 新建Turso数据库（非Windows系统）
      • 配置OAuth提供商（GitHub/Discord/Google/Auth0）
      • 设置加密密钥等关键变量

  2. 在设置数据库时，该命令会按需自动安装并完成 Turso CLI 的认证流程

完整环境变量列表请参阅环境变量文档

users

Section titled “users”
用法: studiocms users [选项]


用户管理系统工具


选项:
  -h, --help  显示帮助信息

create-studiocms

Section titled “create-studiocms”

完整命令选项

Section titled “完整命令选项”
用法: create-studiocms [选项] [命令]


选项:
  -V, --version   显示当前CLI版本
  -h, --help      显示命令帮助
  --color         强制彩色输出
  --no-color      禁用彩色输出


命令:
  get-turso      安装Turso CLI
  help           显示帮助信息
  interactive*   启动交互式CLI


  * 默认命令

使用示例

Section titled “使用示例”
Terminal window
npm create studiocms@latest

create-studiocms 工具默认运行于交互模式，但您也可以通过命令行参数直接指定项目名称与模板。

Terminal window
npm create studiocms@latest -- --template studiocms/basics --project-name my-project

完整模板列表^可在GitHub仓库查看。

使用 --template 参数时，CLI会在模板仓库中搜索所有文件夹。例如，studiocms/basics 模板对应仓库根目录下 studiocms 文件夹中的 basics 项目。

命令详解

Section titled “命令详解”

interactive (默认命令)

Section titled “interactive (默认命令)”
用法: create-studiocms interactive [选项]


启动交互式项目创建向导 [基于clack](https://clack.cc)


选项:
  -t, --template <模板>           使用指定模板
  -r, --template-ref <模板引用>   指定模板版本引用
  -p, --project-name <项目名称>  指定项目名称
  -i, --install                  自动安装依赖
  -g, --git                      初始化Git仓库
  -y, --yes                      跳过所有提示使用默认值
  -n, --no                       跳过所有提示使用默认值
  -q, --skip-banners             跳过引导提示
  -d, --dry-run                  模拟运行（不实际执行）
  -h, --help                     显示帮助信息
  --do-not-install               跳过依赖安装
  --do-not-init-git              跳过Git初始化

get-turso

Section titled “get-turso”

您可通过 Turso 官方安装文档^提供的脚本下载并安装最新版本。

用法: getTurso [选项]


Turso CLI 安装器


选项:
  -h, --help  显示命令帮助信息

@studiocms-upgrade

Section titled “@studiocms-upgrade”

专用于升级 StudioCMS 运行环境和依赖项的命令行工具。

在终端运行此命令时，将在升级 StudioCMS 的同时，同步更新您项目中的官方 Astro 核心模块及所有集成依赖。

使用示例

Section titled “使用示例”
Terminal window
npx @studiocms/upgrade

可选参数

Section titled “可选参数”

tag (指定版本)

Section titled “tag (指定版本)”

默认使用 latest 版本，支持其他版本标签：

Terminal window
npx @studiocms/upgrade beta