contentful-cli

Contentful CLI

Contentful's command line interface tool. Use Contentful features straight from your CLI.

Contentful is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit & manage content in the cloud and publish it anywhere via a powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations.

:rocket: Features

• Securely login and logout with our OAuth service.
• Manage spaces - List, create, ...
• Seed your space with example data
• Run a guide which introduces you to the Contentful basics.
• More to come soon! 🚀

:cloud: Installation

Using npm:

npm install -g contentful-cli

Using yarn:

yarn global add contentful-cli

Please note that for the non standalone versions you need node => v6 to use the CLI.

Using Brew on MacOS:

brew install contentful-cli

Standalone installation on Linux or MacOS:

• Download the latest version of the executeable for your OS
• Add the download directory to path export PATH=$PATH:~/downloaddirectory
• You now have the Contentful cli tool installed.

Standalone installation on Windows:

• Download the latest version of the .exe
• Add the executeable to your Path:
  1. Open the start menu and type "Edit environment variables"
  2. Click "Edit environment variables for your account"
  3. In the User variables box select the Path variable.
  4. Click "Edit..."
  5. In the new dialog, click "New"
  6. Add the location where you downloaded the .exe and click OK
  7. Restart your system
• You now have the Contentful cli tool installed.

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

contentful --help
# or
contentful space --help

:books: Documentation

More detailed documentation for every command can be found in the docs section.

:hammer_and_wrench: Development

After installing the dependencies, there is a trick to get your version of the CLI tool available globally on your system:

npm link

This may collide with your already globally installed Contentful CLI. Make sure to remove that one first.

:question: Support

If you have a problem with this tool, please file an issue here on Github.

If you have other problems with Contentful not related to this library, you can contact Customer Support.

:writing_hand: Contributing

See CONTRIBUTING.md

:scroll: License

MIT