La CLI (Interfaz de Línea de Comandos)

Las CLIs de StudioCMS son utilidades que te permiten crear rápidamente nuevos proyectos de StudioCMS y exponer utilidades útiles para StudioCMS.

Hay dos CLIs diferentes que son parte del ecosistema de StudioCMS:

studiocms: La CLI de utilidad de StudioCMS.
create-studiocms: La CLI de creación de proyectos de StudioCMS.
@studiocms/upgrade: Actualiza proyectos de StudioCMS y sus complementos.

A continuación se presenta un desglose de la CLI de StudioCMS y sus componentes.

`studiocms`

Opciones completas de CLI y comandos

Uso: studiocms [opciones] [comando]

Opciones:
  -V, --version  Muestra la versión actual del Kit de Herramientas CLI.
  -h, --help     mostrar ayuda para el comando
  --color        forzar salida de color
  --no-color     deshabilitar salida de color

Comandos:
  add            Agregar complemento(s) de StudioCMS a tu proyecto
  crypto         Utilidades de Crypto para Seguridad
  get-turso      Instalar la CLI de Turso
  init           Inicializar el proyecto de StudioCMS después de la nueva instalación.
  users          Utilidades para modificar usuarios en StudioCMS

Ejemplo de uso

Desde la raíz de tu proyecto de StudioCMS

npm run studiocms [comando]

pnpm studiocms [comando]

yarn studiocms [comando]

Desglose de comandos

`add`

uso: studiocms add <plugins...>

Agrega complemento(s) de StudioCMS a tu proyecto.

Argumentos:
  plugins    Complemento(s) a instalar

Opciones:
  -h, --help  mostrar ayuda para el comando

`crypto`

uso: studiocms crypto [comando]

Utilidades de Crypto para Seguridad

Opciones:
  -h, --help  mostrar ayuda para el comando

Comandos:
  gen-jwt     Generar token JWT a partir de un archivo de clave

`crypto gen-jwt`

uso: studiocms crypto gen-jwt [opciones] <key-file>

Genera un token JWT a partir de un archivo de clave

Arguments:
  key-file                     una ruta relativa (por ejemplo, `../keys/libsql.pem`) desde el directorio actual a tu archivo de clave privada (.pem)

Options:
  -c, --claim <claim...>.      reclamo en la forma [key=value]
  -e, --exp <date-in-seconds>  Fecha de caducidad en segundos (>=0) desde el tiempo emitido (iat)
  -h, --help                   mostrar ayuda para el comando

`get-turso`

Descarga e instala la última versión de Turso utilizando el script de la documentación^ de Turso

Uso: getTurso [opciones]

Instalador de CLI de Turso

Opciones:
  -h, --help  mostrar ayuda para el comando

`init`

Uso: studiocms init [opciones]

Inicializa el proyecto de StudioCMS después de una nueva instalación.

Opciones:
  -d, --dry-run     Modo de prueba
  --skip-banners    Omitir todos los banners
  --debug           Habilitar modo de depuración
  -h, --help        Mostrar ayuda para el comando

El comando init proporciona una experiencia de configuración interactiva que te ayuda a:

Configura tu archivo de entorno (.env) con opciones para:
- Usa una plantilla de .env de ejemplo
- Usa el constructor interactivo de .env que puede:
  - Configura una nueva base de datos Turso (si no estás en Windows)
  - Configura los proveedores de OAuth (GitHub, Discord, Google, Auth0)
  - Configura claves de cifrado y otras variables requeridas
- Omitir la creación del archivo de entorno
El comando incluye la instalación automática de la CLI de Turso y la autenticación si es necesario al configurar una base de datos.

Para una lista completa de variables de entorno, consulta la documentación de Variables de Entorno.

`users`

uso: studiocms users [opciones]

Utilidades para modificar usuarios en StudioCMS

Opciones:
  -h, --help  mostrar ayuda para el comando

`create-studiocms`

Opciones completas de CLI y comandos

Uso: create-studiocms [opciones] [comando]

Opciones:
  -V, --version  Muestra la versión actual del Kit de herramientas CLI.
  -h, --help     muestra ayuda para el comando
  --color        forzar salida en color
  --no-color     deshabilitar salida en color

Comandos:
  get-turso      Obtener la última versión de Turso.
  help           Mostrar ayuda para el comando
  interactive*   Iniciar la CLI interactiva.

  * Indica el comando predeterminado que se ejecuta al llamar a esta CLI.

Ejemplo de uso

npm create studiocms@latest

pnpm create studiocms

yarn create studiocms

create-studiocms se ejecuta automáticamente en modo interactivo, pero también puedes especificar el nombre de tu proyecto y la plantilla con argumentos de línea de comandos.

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

pnpm create studiocms --template studiocms/basics --project-name my-studiocms-project

yarn create studiocms --template studiocms/basics --project-name my-studiocms-project

Consulta la lista completa^ de plantillas, disponibles en GitHub.

Cuando se usa --template, la CLI busca las plantillas en el repositorio de todas las carpetas. Por ejemplo, la plantilla studiocms/basics apunta al proyecto basics dentro de la carpeta studiocms en la raíz del repositorio.

Desglose de comandos

Interactivo (comando predeterminado)

Uso: create-studiocms interactive [opciones]

Empieza la CLI interactiva. Impulsada por [clack](https://clack.cc).

Este comando abrirá un aviso de CLI interactivo para guiarte a través
el proceso de creación de un nuevo proyecto de StudioCMS (o paquete del ecosistema de StudioCMS)
usando una de las plantillas disponibles.

Opciones:
  -t, --template <template>          La plantilla a utilizar.
  -r, --template-ref <template-ref>  La plantilla de referencia a utilizar.
  -p, --project-name <project-name>  El nombre del proyecto.
  -i, --install                      Instalar dependencias.
  -g, --git                          Inicializar un repositorio git.
  -y, --yes                          Omitir todos los mensajes y usa valores predeterminados.
  -q, --skip-banners                 Omitir todos los banners y mensajes.
  -d, --dry-run                      No realizar ninguna acción.
  -h, --help                         mostrar ayuda para el comando
  --do-not-install                   No instalar dependencias.
  --do-not-init-git                  No inicializar un repositorio git.

`get-turso`

Puedes descargar e instalar la última versión de Turso utilizando el script de la documentación^ de Turso.

Uso: getTurso [opciones]

Instalador de CLI de Turso

Opciones:
  -h, --help  mostrar ayuda para el comando

`@studiocms-upgrade`

Una herramienta de línea de comandos para actualizar tu instalación de StudioCMS y sus dependencias.

Puedes ejecutar este comando en tu terminal para actualizar tu proyecto oficial de Astro, integraciones al mismo tiempo que actualizas StudioCMS.

Ejemplo de uso

npx @studiocms/upgrade

pnpm dlx @studiocms/upgrade

yarn dlx @studiocms/upgrade

Opciones

tag (opcional)

Es posible pasar un tag específico para resolver paquetes. Si no se incluye, @studiocms/upgrade busca la etiqueta latest.

npx @studiocms/upgrade beta

pnpm dlx @studiocms/upgrade beta

yarn dlx @studiocms/upgrade beta