contentful-import

Contentful import tool

https://www.contentful.com 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 powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations.

This Command Line Tool (CLI) helps you to import files generated by the contentful-export tool to new and empty Contentful spaces.

Installation

We recommend you install the CLI via npm:

npm install -g contentful-import

Usage and examples

Usage: contentful-import [options]

Options:
  --version                  Show version number                       [boolean]

  --space-id                 ID of the destination space     [string] [required]

  --management-token         Contentful management API token for the destination
                             space                           [string] [required]

  --content-file             JSON file that contains data to be import to your
                             space                           [string] [required]

  --content-model-only       Import only content types[boolean] [default: false]

  --skip-content-model       Skip importing content types and locales
                                                      [boolean] [default: false]

  --skip-locales             Skip importing locales   [boolean] [default: false]

  --skip-content-publishing  Skips content publishing. Creates content but does
                             not publish it           [boolean] [default: false]

  --error-log-file           Full path to the error log file            [string]

  --proxy                    Proxy configuration in HTTP auth format: host:port
                             or user:password@host:port                 [string]

  --config                   An optional configuration JSON file containing all
                             the options for a single run

Example

contentful-import \
  --space-id spaceID \
  --management-token managementToken \
  --content-file exported-file.json \

or

contentful-import --config example-config.json

You can create your own configuration file based on the example-config.json file.

Usage as a library

While this tool is intended for use as a command line tool, you can also use it as a Node library:

let spaceImport = require('contentful-import')
let options = {
    content: {entries:..., contentTypes:..., locales:...},
    spaceId: 'SPACE_ID',
    managementToken: 'MANAGEMENT_TOKEN'
}
spaceImport(options)
.then((output) => {
  console.log('Data Imported successfully')
})
.catch((err) => {
  console.log('oh no! errors occurred!', err)
})

The options object can contain any of the CLI options, but written with a camelCase pattern instead and no dashes. For example --space-id would become spaceId.

Limitations

• This tool currently does not support the import of space memberships.
• This tool is expecting the target space to have the same default locale as your previously exported space.
• Imported webhooks with credentials will be imported as normal webhooks. Credentials should be added manually afterwards.
• If you have custom UI extensions, you need to reinstall them manually in the new space.

Changelog

Read the releases page for more information.

License

This project is licensed under MIT license