Skip to content

cli.mdx

Latest commit

 

History

History
279 lines (189 loc) · 8.12 KB

cli.mdx

File metadata and controls

279 lines (189 loc) · 8.12 KB
i18nReady true
title La CLI (Interfaz de Línea de Comandos)
description Aprende sobre las CLIs de StudioCMS y cómo usarlas.
sidebar
order
2
tableOfContents
minHeadingLevel maxHeadingLevel
2
4

import { Tabs, TabItem, Steps } from '@astrojs/starlight/components'; import { PackageManagers } from 'starlight-package-managers' import ReadMore from '~/components/ReadMore.astro';

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:

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  Imprime la versión actual de la CLI Toolkit.
  -h, --help     mostrar ayuda para el comando

COMMANDS
  - add               Agrega plugin(s) de StudioCMS a tu proyecto
  - crypto            Utilidades de Crypto para la seguridad de StudioCMS
  - get-turso         Instala el CLI de Turso
  - init              Inicializa el proyecto de StudioCMS después de una nueva instalación.
  - users             Utilidades para ajustar usuarios en StudioCMS
  - migrate           Gestiona las migraciones de la base de datos para StudioCMS.

Ejemplo de uso

Desde la raíz de tu proyecto de StudioCMS

<PackageManagers type="exec" pkg="studiocms" args={'[command]'} />

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:
  -e, --exp <fecha-en-segundos>  Fecha de caducidad en segundos (>=0) desde el tiempo emitido (iat)
  -h, --help                     mostrar ayuda para el comando

debug

Uso: studiocms debug [opciones]

Muestra información de depuración sobre tu instalación de StudioCMS.

Options:
  -h, --help  mostrar ayuda para el comando
  --debug     Habilitar modo de depuración

get-turso

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

:::note Windows requiere el uso de WSL según 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:

  1. 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

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

migrate

Uso: studiocms migrate [opciones]

Gestiona las migraciones de la base de datos para StudioCMS.

Opciones:
  -h, --help      mostrar ayuda para el comando
  --debug         Habilitar modo de depuración
  -r, --rollback  Revertir la última migración
  -l, --latest    Migrar a la última versión
  --status        Mostrar el estado actual de la migración

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

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.

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.

:::note Windows requiere el uso de WSL según 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

Opciones

tag (opcional)

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