cfimp

cfimp is a simple but powerful CLI tool for importing/updating CSV data in the Contentful headless CMS. The default delimiter is tab.

In the process of importing/updating, entries can optionally be linked to (existing) assets, tags or references (foreign items).

cfimp cannot be used to create new assets, tags, models or anything other than entries.

Why

Contentful doesn't make it super easy to import data. There's no GUI; instead the contentful-cli tool has an import command, but it's sparsely documented, and you first have to munge your data into JSON. There's no easy way to import spreadsheet-derived data. Further, Contentful doesn't make explicit what the structure of the JSON should be.

Examples

#Import comma-separated data from import.csv to space "12345" / content type (model) "authors" / locale "en-GB"
cfimp -space:12345 -model:authors -locale:en-GB 

#Also specify some tags (for all rows)
cfimp -space:12345 -model:authors -locale:en-GB -tags:foo,bar

#Specify a fallback (default) value "bar" for the "foo" field
cfimp -space:12345 -model:authors -locale:en-GB -dfltvals:foo=bar

#Preview the generated JSON of the first entry - no actual import takes place
cfimp -space:12345 -model:authors -locale:en-GB -preview

Prerequisites

1. Install contentful-cli globally.

npm install -g contentful-cli

2. Authenticate with Contentful (optional).

contentful login

Authenticating this way will save the credentials in your environment so you don't have to authenticate manually each time you use cfimp. If you'd rather do that instead, though, see the mtoken argument.

3. Install cfimp globally

npm i -g cfimp

Usage

Note: the default delimiter is tab. This can be changed via the delim arg.

It's strongly recommended to preview the generated data before running the write. See the preview arg.

cfimp <args>

Arguments are specified in the format -arg:val or, where the argument doesn't accept a value (denoted * below), simply -arg. Where val contains spaces, use -arg:"one two".

Valid arguments are as follows.

• input - path to the input file (optional; default: "import.csv")
• space - the ID of the Contentful space to write to (required)
• model - the ID of the Contentful model (content type) to write to (required)
• locale - the locale, as defined in Contentful, e.g. "[en-GB]". See Writing to multiple locales (required)
• preview* - if passed, shows a preview of the data that will be written to Contentful; no write is performed. See Troubleshooting (optional)
• previewfile* - if passed, quits after generating the Contentfil JSON file, so you can inspect it. See Troubleshooting (optional)
• env - the ID of the Contentful environment to use (optional; default: "master")
• publish* - sets the imported/updated entries to "published" status rather than "draft" (optional)
• mergevals - a com-sep list of field=value pairs - to merge into all rows. See Merge and default values (optional)
• dfltvals - a com-sep list of field=value defaults to be used anywhere a row has empty cells. See Merge and default values (optional)
• delim - the delimiter separating columns (for multi-column files) - one of "tab", "com" (comma) or any other string (optional; default: "tab")
• fields - the fields to import into. If omitted, cfimp will assume the first row of the input data denotes the fields (optional)
• enc - the file encoding for your data (you shouldn't need to change this) - one of "utf8", "ascii" or "base64" (optional; default: "utf8")
• offset - a 1-index offset (row) to begin reading data from in your input file (optional)
• limit - a limit as to the number of rows to process (optional)
• skiprows - a com-sep list of strings which, if any is found in a row (any column), will cause that row to be skipped. The logic can be inverted. See Filtering rows (optional)
• skipfields - a com-sep list of field IDs to ignore from the input. Useful if your spreadsheet export contains columns you don't want to include (optional)
• nocast - ordinarily, numbers, true and false will be cast to their integer/boolean equivalents when data is passed to Contentful. Pass true to prevent this (i.e. if you literally want to pass "true" not true) (optional)
• tagall - a com-sep list of (existing) tags to tag all entries with. You can also specify row-specific tags. See Tagging items (optional)
• listdelim - the delimiter used within list values e.g. default values, tags (optional; default: ","). See Delimiter overrides
• mtoken - a management token to authenticate with Contentful. You can omit this if you've already authenticated via contentful login (optional)

Reference and asset links

It's possible to link to existing assets or references (i.e. foreign items in other content types) via the ref- (reference) and refa- (asset) prefixes.

In both cases, you'll need to know the ID of the item you're linking to.

Suppose you had a content type of authors and had a field, authorPhoto which was an asset field. We'd link authors to their photos like so:

forename	surname	authorPhoto
Philippa	Gregory	refa-12345
Desdemona	Johnson	refa-67890

If for some reason all our authors have the same face and photo, we can even specify this at runtime with a merge value (ee Merge and default values):

cfimp -space:12345 -model:authors -locale:en-GB -mergevals:authoBioPhoto=refa-12345

Merged and default values

It's possible to specify default fallback values for your data, which will take effect if the cell is empty for that field.

It's also possible to merge extra data into all rows.

Let's say you have a field in your data, "popular", with some rows having "yes" as a value. For all others, with no value, you want to insert "no". We can accomplish this via the dfltvals argument:

cfimp -space:12345 -model:authors -locale:en-GB -dfltvals:popular=no

Or let's say you want to add an extra field to all rows. Perhaps you meant (but forgot) to add an "age" column to your spreadsheet data before exporting it, and it so happens that, surprisingly, all the authors in your data are 51. We can accomplish this via the mergevals argument:

cfimp -space:12345 -model:authors -locale:en-GB -mergevals:age=51

Updating existing items

Be careful when updating existing items; be sure to specify values for all fields, because Contentful's import service doesn't retain values for omitted fields.

cfimp can be used to update existing items in Contentful rather than import (create) new ones. To do this, include an _id column in your data. This will be inferred as the internal Contentful ID of the item, and will update it.

forename	surname	_id
Philippa	Gregory	12345

Multiple locales

All data in Contentful is stored against locales, created by you in Contentful. This allows you to have multiple versions of each piece of data, for different locales. By default, cfimp will import/update data using the locale specified in the locale arg.

However you can import/update multiple locales at once. To do so, specify the field as many times as you have locales, with each additional one appended with a locale flag.

So if your data was:

London	Londres
Berlin	Berlina

You can spefify locales either in the data itself, if the first row of data represents your field IDs:

city	city[es-SP]
London	Londres
Berlin	Berlina

...or via the fields argument, if you're specifying field IDs at runtime.

cfimp -space:12345 -model:cities -locale:en-GB -fields:city,city[es-SP]

Tagging items

It's possible to tag items to (existing) tags when importing or updating items. There are two ways to do this.

You can specify item-specific tags in your data, via the _tags field.

forename	surname	_tags
Philippa	Gregory	foo,bar

You can also tag all items at runtime via the tagall argument.

cfimp -space:12345 -model:authors -tagall:foo,bar

Note: tags specified in this way are subject to the listdelim argument.

Importing geopositional data

When importing geopositional data, specify coordinates in the format

lat,lng

i.e.

51.467283887530094,-0.24193970047025806

cfimp will convert this into an object before writing to Contentful. Note also that this means you'll need to use a non-comma value for delim, since the geoposition data itself contains a comma.

Filtering rows

It's possible to stipulate which rows you do, or do not, want to be imported/updated from your input file, via the skiprows argument.

This argument is used to whitelist or blacklist certain rows, and accepts a com-sep list of values to blacklist or, if the entire argument value is prefixed with !, to allow.

The following will blacklist (skip) any rows that contain, in any column, "foo" OR "bar"

cfimp ... -skiprows:foo,bar

The following will whitelist (include) any rows that contain "foo" OR "bar"; all other rows will be skipped.

cfimp ... -skiprows:!foo,bar

Publishing entries

cfimp can publish entries when importing or updating them. To stipulate this, pass the publish argument. If this is omitted, the entry will end up in draft status or, for updated entries, whatever its current status is.

Note that, when importing and publishing new items, cfimp will generate item IDs itself, rather than leave it to Contentful. This is a requirement of Contentful's import tool; in order to publish items, it requires an ID to be generated by the client.

Such IDs will be formed of 11 randomly alphanumeric characters.

Delimiter overrides

Delimiters are factors in two areas of cfimp:

• the delimiter used to separate the values in your input file
• the delimiter used to separate any (normally) comma-separated pairings in arguments or _tag field values

Both of these can be overriden - the former via the delim arg and the latter via the listdelim arg. Note that listdelim will apply to all occasions where cfimp is attempting to decipher something that it normally expects to be in com-sep format - so for example _tags fields, the mergevals argument, and so on.

Troubleshooting

It's HIGHLY recommended to preview the generated data before running the actual import/data. This shows you what cfimp intends to send to Contentful for import/update.

This can be done in two ways:

• Via the preview argument: this should be considered preview 'lite', and will spit out in the console the data cfimp has compiled, before converting to the JSON format Contentful requires
• Via the previewfile argument: this goes a step further, and actually creates the JSON file Contentful requires that effects the import/update. Once created, you can inspect this file.

(Note: Neither argument expects a value.)

Additionally, a limit is handy in order to avoid numerous terminal screens of data.

If you find cfimp is deriving or malformed bad data, check the delim and listdelim args.

Like this?

If I've helped you, consider being amazing and buying me a coffee - thank you!