Skip to content

Commit

Permalink
new import/export command - update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KarolNet committed Nov 28, 2024
1 parent 3a9d63e commit aa74106
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,7 @@ This command exports data from the Flotiq account to local JSON files. If the ke
`flotiq import [projectName] [flotiqApiKey]`

This command imports Content Types and Content Objects to your Flotiq account using the API key.
Source directory must include directory with `ContentType[0-9]` folders, each of them containing ContentTypeDefinition.json file, and `contentObject[0-9].json` files.

The number at the end of the directory or file name defines the file import order.
The `./images` directory in a particular starter stores images that will be imported into your Media Library.
Source directory must include directory with `ContentType[Name]` folders, each of them containing ContentTypeDefinition.json file, and `contentObject[Name].json` files.

The command can import data output of the `flotiq export` command.

Expand All @@ -65,10 +62,6 @@ The command can import data output of the `flotiq export` command.
* `projectName` - project name or project path (if you wish to start or import data from the directory you are in, use `.`)
* `flotiqApiKey` - read and write API key to your Flotiq account

#### Note

It is also possible to perform the import and export manually, using the Flotiq API without relying on the CLI importer. However, when doing this, you need to ensure that image URLs are updated, as images will receive new IDs during the migration process. This requires careful handling to avoid broken links in your Content Objects. For more details on how to properly handle this, refer to the [Flotiq API documentation](https://flotiq.com/docs/).

### Launch a Flotiq starter project

`flotiq start [projectName] [flotiqStarterUrl] [flotiqApiKey]`
Expand Down

0 comments on commit aa74106

Please sign in to comment.