contentful cli

CLI contenta

Herramienta de interfaz de línea de comandos de Contentful. Utilice funciones de contenido directamente desde su CLI.

Contentful proporciona una infraestructura de contenido para que los equipos digitales impulsen el contenido en sitios web, aplicaciones y dispositivos. A diferencia de un CMS, Contentful se creó para integrarse con la pila de software moderna. Ofrece un centro central para contenido estructurado, potentes API de administración y entrega, y una aplicación web personalizable que permite a los desarrolladores y creadores de contenido enviar productos digitales más rápido.

Características

• Comience con Contentful con el comando init .
• Administrar espacios: enumerar, crear, eliminar,...
• Exporta tu espacio a un archivo JSON.
• Importa tu espacio desde un archivo JSON.
• Ejecutar scripts de migración escritos en Contentful Migration DSL
• Genere scripts de migración para DSL de Contentful Migration desde espacios existentes.
• Siembra tu espacio con datos de ejemplo.
• Gestionar la instalación de extensiones en un espacio.
• Inicie sesión y cierre sesión de forma segura con nuestro servicio OAuth.
• Encuentre todos los comandos disponibles en la sección de documentos.

☁️ Instalación

Asegúrate de tener instalado Node LTS

Luego usando npm o hilo:

npm install -g contentful-cli
# Or
yarn global add contentful-cli

Tenga en cuenta que para las versiones no independientes necesita Node LTS para usar la CLI.

Uso

Utilice el parámetro --help para mostrar la sección de ayuda de la herramienta CLI o combínelo con un comando específico para obtener la sección de ayuda para ese comando.

contentful --help
# Or
contentful space --help

Documentación

Puede encontrar documentación más detallada para cada comando en la sección de documentos.

Usando la herramienta CLI con un proxy

Puede guardar la configuración del proxy en su .contentfulrc.json mediante:

contentful config add --proxy user:auth@host:port

También respetamos las variables de entorno http(s)_proxy :

https_proxy=user:auth@host:port contentful

Cuando existen varias configuraciones de proxy, la prioridad se toma de esta forma:

1. http_proxy tiene prioridad sobre .contentfulrc.json
2. https_proxy tiene prioridad sobre .contentfulrc.json
3. https_proxy tiene prioridad sobre http_proxy

Configuración de la CLI para uso en la UE

Puede anular la configuración del host en su .contentfulrc.json mediante:

contentful config add --host api.eu.contentful.com

Entonces, cualquier comando posterior utilizará el host de la UE. Por ejemplo, contentful login iniciará sesión en su instancia con contenido de la UE.

⛑️ Solución de problemas

• ¿No puedes conectarte a Contentful a través de tu proxy? Pruebe la configuración rawProxy: true en su .contentfulrc.json mediante:

contentful config add --raw-proxy

Desarrollo

1. Instalar dependencias

   npm i

2. Para evitar que la versión de desarrollo colisione con su CLI Contentful ya instalada, cambie el nombre del comando en package.json

     "bin": {
   -     "contentful": "bin/contentful.js"
   +     "ctfl": "bin/contentful.js"
     }

3. Vincula tu versión local y ¡feliz pirateo!

   npm link

? Pruebas

Pruebas de integración

Para ejecutar pruebas de integración localmente, necesitará lo siguiente:

1. Establezca variables de entorno en .jest/env.js (se puede encontrar en 1Password)

    process . env . CONTENTFUL_INTEGRATION_TEST_CMA_TOKEN = '<cma_auth_token>'
   process . env . CLI_E2E_ORG_ID = '<organization_id>'

2. Ejecute el proxy talkback para grabar y reproducir solicitudes http

   npm run talkback-proxy

3. En otro terminal ejecute sus pruebas preferidas

    # # Run all integration tests
   npm run test:jest
   # # Or run specific tests
   npx jest test/integration/cmds/space/ * --watch

Pruebas unitarias

Simplemente ejecuta:

 # Run all unit tests
npm run test:unit:watch
# Or run specific tests
npx jest test/unit/cmds/ * --watch

Consulte la documentación de Jest para obtener más detalles sobre la ejecución de pruebas y indicadores opcionales.

Actualización de instantáneas

Es posible que necesites actualizar las instantáneas y resulta complicado con las grabaciones.

Consejo: ejecute pruebas sin grabaciones para actualizar las instantáneas.

 npx jest test/integration/cmds/<path to the affected test file> --updateSnapshot

❓ Soporte

Si tiene algún problema con esta herramienta, presente un problema aquí en Github.

Si tiene otros problemas con Contentful no relacionados con esta biblioteca, puede comunicarse con Atención al cliente.

✍️ Contribuyendo

Ver CONTRIBUCIÓN.md

Licencia

MIT