Contentful Update Tool and Extractor. Bulk upload and download from excel/csv/tsv/yaml/json/sql. Bulk content generator via AI using prompts in your Contentful space.
Contentful Update Tool and Extractor. Bulk upload and download from excel/csv/tsv/yaml/json/sql. Bulk content generator via AI using prompts in your Contentful space.
A Contentful Update Tool & Extractor
cute is a cross-platform CLI tool that brings several advanced features and capabilities to working with your content hosted on Contentful.
typegen command option which exports TypeScript (TS) interface declarations. This feature is especially useful to keep your JavaScript or .NET projects in sync with your content types.Contentful is a content infrastructure platform that lets you create, manage and distribute content to any platform.
Contentful bills itself as a Content Infrastructure Platform rather than a traditional Content Management System (CMS) that is often no more than a simple web publishing tool.
It aims to transcend traditional Content Management Systems (CMS) by structuring its technology offering around three principals:
For windows (cmd or powershell):
winget install Microsoft.DotNet.SDK.8
Or, on linux and iOS
sudo apt-get update && sudo apt-get install -y dotnet-sdk-8.0
On windows you may have to close and re-open the command line prompt (or Windows Terminal).
Install the cute cli by typing.
dotnet tool install -g cute
Simply type
cute
This will display the cute help. You are ready to go! 🚀
cute --help
cute login
cute info
The default format is 'excel' so the following is equivalent.
cute download --content-type <contentType>
cute download --content-type <contentType> --format excel
For comma separated values:
cute download --content-type <contentType> --format csv
For tab separated values:
cute download --content-type <contentType> --format tsv
For json output:
cute download --content-type <contentType> --format json
For downloading to Yaml:
cute download --content-type <contentType> --format yaml
Typing cute download --help will list all currently available options and usage
USAGE:
cute download [OPTIONS]
OPTIONS:
-h, --help Prints help information
-c, --content-type Specifies the content type to download data for
-f, --format The output format for the download operation (Excel/Csv/Tsv/Json/Yaml)
You can upload content from a local file to contentful. The local file can be a previously downloaded and updated excel, sdv, tsv, json or yaml file.
Changes are only applied to Contentful if --apply is specified. By default no changes will be applied so it works a bit like a "what-if" powershell switch without --apply.
Typing cute upload --help will sow the full usage and options.
USAGE:
cute upload [OPTIONS]
OPTIONS:
-h, --help Prints help information
-c, --content-type Specifies the content type to download data for
-p, --path The local path to the file containing the data to sync
-f, --format The format of the file specified in '--path' (Excel/Csv/Tsv/Json/Yaml)
-a, --apply Apply and publish all the calculated changes. The default behaviour is to only list the detected changes
You can generate strongly typed classes for both c# and TypeScript using cute.
USAGE:
cute typegen [OPTIONS]
OPTIONS:
-h, --help Prints help information
-c, --content-type Specifies the content type to generate types for. Default is all
-o, --output The local path to output the generated types to
-l, --language The language to generate types for (TypeScript/CSharp)
-n, --namespace The optional namespace for the generated type
You can generate content using OpenAI in bulk. Prompts are retrieved from your Contentful space. A typical prompt entry has an id, a system message, a prompt, points to a content type and field. Something like :-
| Title | EntryField |
|---|---|
| title | Short text |
| SystemMessage | Long text |
| MainPrompt | Long text |
| ContentTypeId | Short text |
| ContentFieldId | Short text |
DESCRIPTION:
Use generative AI to help build drafts of your content.
USAGE:
cute generate [OPTIONS]
OPTIONS:
-h, --help Prints help information
-c, --prompt-content-type The id of the content type containing prompts. Default is 'prompts'
-f, --prompt-field The id of the field that contains the prompt key/title/id. Default is 'title'
-i, --prompt-id The title of the Contentful prompt entry to generate content from
-l, --limit The total number of entries to generate content for before stopping. Default is five
-s, --skip The total number of entries to skip before starting. Default is zero
cute login ...
cute logout ...
cute info
cute profile ...
cute content ...
cute type ...
cute app ...
cute server...
cute report ...
cute version
Log in to Contentful. Run this first.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| -n, --openai-deployment-name | No | The Azure OpenAI deployment name. |
| -a, --openai-endpoint | No | The Azure OpenAI endpoint. |
| -k, --openai-token | No | The Azure OpenAI Api key. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Log out of contentful.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| -n, --openai-deployment-name | No | The Azure OpenAI deployment name. |
| -a, --openai-endpoint | No | The Azure OpenAI endpoint. |
| -k, --openai-token | No | The Azure OpenAI Api key. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Display information about a Contentfult space.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Manage content entries in bulk.
Download Contentful entries to a local csv/tsv/yaml/json/excel file.
| Option | Required | Description |
|---|---|---|
| -c, --content-type-id | No | The Contentful content type id. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| -f, --format | No | The output format for the download operation (Excel/Csv/Tsv/Json/Yaml) |
-l, --locale | No | The locale code (eg. 'en') to apply the command to. Default is all. |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| -p, --path | No | The output path and filename for the download operation |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Upload and sync Contentful entries from a local csv/tsv/yaml/json/excel file.
| Option | Required | Description |
|---|---|---|
| -a, --apply | No | Apply and publish all the calculated changes. The default behaviour is to only list the detected changes. |
| -c, --content-type-id | No | The Contentful content type id. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| -f, --format | No | The format of the file specified in '--path' (Excel/Csv/Tsv/Json/Yaml) |
-l, --locale | No | The locale code (eg. 'en') to apply the command to. Default is all. |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -m, --match-field | No | The optional name of the field to match in addition to the entry id. |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| -p, --path | No | The local path to the file containg the data to sync |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Edit Contentful entries in bulk with an optional filter.
| Option | Required | Description |
|---|---|---|
| -a, --apply | No | Apply and publish all the required edits. The default behaviour is to only list the detected changes. |
| -c, --content-type-id | No | The Contentful content type id. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| -f, --field | No | The field to update. |
| --force | No | Specifies whether warning prompts should be bypassed |
-l, --locale | No | The locale code (eg. 'en') to apply the command to. |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -r, --replace | No | The value to update it with. Can contain an expression. |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Find and Replace values in Contentful entries in bulk with an optional filter.
| Option | Required | Description |
|---|---|---|
| -a, --apply | No | Apply and publish all the required edits. The default behaviour is to only list the detected changes. |
| -c, --content-type-id | No | The Contentful content type id. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| -f, --field | No | The field to update. |
| -i, --find | No | The text to find. |
| --force | No | Specifies whether warning prompts should be bypassed |
-l, --locale | No | The locale code (eg. 'en') to apply the command to. |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -r, --replace | No | The value to update it with. Can contain an expression. |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Bulk publish all unpublished Contentful entries.
| Option | Required | Description |
|---|---|---|
| -c, --content-type-id | No | The Contentful content type id. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Unpublish all published Contentful entries.
| Option | Required | Description |
|---|---|---|
| -c, --content-type-id | No | The Contentful content type id. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Unpublish and delete all Contentful entries.
| Option | Required | Description |
|---|---|---|
| -c, --content-type-id | No | The Contentful content type id. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Synchromise data to Contentful from an API.
| Option | Required | Description |
|---|---|---|
| -a, --apply | No | Apply and publish all the required edits. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| -k, --key | No | The key of the cuteContentSyncApi entry. |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| -u, --use-filecache | No | Whether or not to cache responses to a local file cache for subsequent calls. |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Synchromise data to Contentful from an API.
| Option | Required | Description |
|---|---|---|
| -c, --content-type-prefix | No | The id of the content type containing location data. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| -h, --huge-population | No | The city or town minimum population for large cities |
| -i, --input-file | No | The path to the input file. |
| -l, --large-kilometer-radius | No | The distance in kilometers for large city to nearest location |
| -n, --large-population | No | The city or town minimum population for large cities |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| -o, --output-folder | No | The output folder. |
| -p, --password | No | The password to protect the Zip file with |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -m, --small-kilometer-radius | No | The distance in kilometers for small city to nearest location |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| -u, --upload | No | Uploads the csv file to Contentful. |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
| -z, --zip | No | Output a zip file instead of a csv. Can be password protected with '--password'. |
Synchronize data to Contentful from a database.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Generate content using a Large Language Model (LLM).
| Option | Required | Description |
|---|---|---|
| -a, --apply | No | Apply and publish all the required edits. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| -k, --key | No | The key of the 'cuteContentGenerate' entry. |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| -o, --operation | No | Specify the generation operation to perform. (GenerateSingle, GenerateParallel, GenerateBatch or ListBatches) |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Test generation of content using a Large Language Model (LLM).
| Option | Required | Description |
|---|---|---|
| -o, --comparison-operation | No | The comparison operator to apply to the field. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -m, --deployment-models | No | The deployment models to test. |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| -f, --field-id | No | The field id to filter on. |
| -v, --field-value | No | The field value to filter on. |
| --force | No | Specifies whether warning prompts should be bypassed |
| -k, --key | No | The key of the 'cuteContentGenerate' entry. |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Translate content using an LLM or Translation Service.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Generate test data.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| -n, --number | No | The number of user entries to generate. (default=1000). |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Join multiple content types to a destination content type.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -i, --entry-id | No | Id of source 2 entry to join content for. |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| -k, --key | No | The id of the Contentful join entry to generate content for. |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Manage Contentful content types (models).
Automatically scaffold Typescript or c# classes from Contentful.
| Option | Required | Description |
|---|---|---|
| -c, --content-type | No | Specifies the content type to generate types for. Default is all. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| -l, --language | No | The language to generate types for (TypeScript/CSharp/Excel). |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -n, --namespace | No | The optional namespace for the generated type. |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| -o, --output | No | The local path to output the generated types to. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Compare content types across two environments and view with VS Code.
| Option | Required | Description |
|---|---|---|
| -c, --content-type-id | No | Specifies the content type id to generate types for. Default is all. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --source-environment-id | No | Specifies the source environment id to do comparison against |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Clone a content type and its entries between environments.
| Option | Required | Description |
|---|---|---|
| -c, --content-type-id | No | Specifies the content type id to generate types for. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -b, --entries-per-batch | No | Number of entries processed in parallel. |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -p, --publish | No | Whether to publish the created content or not. Useful if no circular references exist. |
| --source-environment-id | No | Specifies the source environment id. |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Rename a content type including all references to it.
| Option | Required | Description |
|---|---|---|
| -a, --apply-naming-convention | No | The id to rename the content type to. |
| -c, --content-type | No | Specifies the content type to generate types for. Default is all. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -n, --new-id | No | The id to rename the content type to. |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -p, --publish | No | Whether to publish the created content or not. Useful if no circular references exist. |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Delete a content type and its entries.
| Option | Required | Description |
|---|---|---|
| -c, --content-type-id | No | Specifies the content type id to be deleted. |
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Generate a website or app from Contentful.
Generate an app or website based on configuration in Contentful.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Tools to evaluate the quality the site and of LLM and translation output.
Use deepeval to measure the quality of content generation.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Measure the quality of translation engine output.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Check and remediate violations of site naming conventions.
| Option | Required | Description |
|---|---|---|
| --delivery-token | No | Your Contentful Content Delivery API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -e, --environment-id | No | The Contentful environment identifier. See https://www.contentful.com/developers/docs/concepts/multiple-environments/ |
| --force | No | Specifies whether warning prompts should be bypassed |
| --log-output | No | Outputs logs to the console instead of the standard messages. |
| --management-token | No | Your Contentful management API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| --no-banner | No | Do not display the startup banner or the copyright message. |
| --preview-token | No | Your Contentful Content Preview API token. See https://www.contentful.com/developers/docs/references/authentication/ |
| -s, --space-id | No | The Contentful space identifier. See https://www.contentful.com/help/spaces-and-organizations/ |
| --verbosity | No | Sets the output verbosity level. Allowed values are (q)uiet, (m)inimal, (n)ormal, (de)tailed and (di)agnostic. |
Display the current version of the CLI.