Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/contentful/contentful-cli
The official Contentful command line interface. Use Contentful features straight from the command line!
https://github.com/contentful/contentful-cli
api cli contentful json
Last synced: 7 days ago
JSON representation
The official Contentful command line interface. Use Contentful features straight from the command line!
- Host: GitHub
- URL: https://github.com/contentful/contentful-cli
- Owner: contentful
- License: mit
- Created: 2017-08-31T13:40:39.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T00:09:59.000Z (21 days ago)
- Last Synced: 2024-12-09T23:36:50.261Z (16 days ago)
- Topics: api, cli, contentful, json
- Language: JavaScript
- Homepage: https://www.contentful.com/developers/docs/tutorials/cli/
- Size: 157 MB
- Stars: 329
- Watchers: 69
- Forks: 61
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Audit: audit-resolve.json
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Contentful CLI
> [Contentful's](https://www.contentful.com) command line interface tool. Use Contentful features straight from your CLI.
[](https://www.npmjs.com/package/contentful-cli)
[](https://circleci.com/gh/contentful/contentful-cli)
[Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
## :rocket: Features
- Get started with Contentful with the `init` command.
- Manage spaces - list, create, delete,...
- Export your space to a JSON file.
- Import your space from a JSON file.
- Execute migration scripts written in the [Contentful Migration DSL](https://github.com/contentful/contentful-migration/blob/main/README.md#reference-documentation)
- Generate migration scripts for the [Contentful Migration DSL](https://github.com/contentful/contentful-migration/blob/main/README.md#reference-documentation) from existing spaces.
- Seed your space with example data.
- Manage installation of [extensions](https://github.com/contentful/extensions) in a space.
- Securely login and logout with our [OAuth service](https://www.contentful.com/developers/docs/references/authentication/).
- Find all available commands in the [docs section](https://github.com/contentful/contentful-cli/tree/main/docs).
## :cloud: Installation
Make sure you have [Node LTS](https://nodejs.org/en/) installed
Then using [npm](https://npmjs.org) or [yarn](https://yarnpkg.com):
```sh
npm install -g contentful-cli
# Or
yarn global add contentful-cli
```
Please note that for the non standalone versions you need Node LTS to use the CLI.
## :hand: Usage
Use the `--help` parameter to display the help section for CLI tool or combined with a specific command to get the help section for that command.
```sh
contentful --help
# Or
contentful space --help
```
## :books: Documentation
More detailed documentation for every command can be found in the [docs section](https://github.com/contentful/contentful-cli/tree/main/docs).
## Using the CLI tool with a proxy
You can save the proxy configuration in your `.contentfulrc.json` via:
```sh
contentful config add --proxy user:auth@host:port
```
We also respect the `http(s)_proxy` environment variables:
```sh
https_proxy=user:auth@host:port contentful
```
When multiple proxy configurations exists, precedence is taken in this form:
1. `http_proxy` takes precedence over `.contentfulrc.json`
2. `https_proxy` takes precedence over `.contentfulrc.json`
3. `https_proxy` takes precedence over `http_proxy`
## Configuring the CLI for EU usage
You can override the host configuration in your `.contentfulrc.json` via:
```sh
contentful config add --host api.eu.contentful.com --host-delivery cdn.eu.contentful.com
```
Then any subsequent command will use the EU hosts. E.g. `contentful login` will log you in to your EU Contentful instance.
## :rescue_worker_helmet: Troubleshooting
- Unable to connect to Contentful through your Proxy? Try settings `rawProxy: true` in your `.contentfulrc.json` via:
```sh
contentful config add --raw-proxy
```
## :hammer_and_wrench: Development
1. Install dependencies
```sh
npm i
```
2. To avoid development version colliding with your already installed Contentful CLI, change the command name in `package.json`
```diff
"bin": {
- "contentful": "bin/contentful.js"
+ "ctfl": "bin/contentful.js"
}
```
3. Link your local version, and happy hacking :tada:
```sh
npm link
```
## :question: Support
If you have a problem with this tool, please file an [issue](https://github.com/contentful/contentful-cli/issues/new) here on Github.
If you have other problems with Contentful not related to this library, you can contact [Customer Support](https://support.contentful.com).
## :writing_hand: Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md)
## :scroll: License
MIT