Skip to content
This repository was archived by the owner on May 19, 2025. It is now read-only.

Fix/cs 42644 #51

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Contentstack Export Utility
# Deprecation Warning

The export utility has been deprecated. We will soon stop supporting this utility. We recommend you to use [Contentstack CLI](https://github.com/contentstack/cli) instead.

## Contentstack Export Utility

Contentstack is a headless CMS with an API-first approach that puts content at the centre. It is designed to simplify the process of publication by separating code from content.

Expand Down Expand Up @@ -31,6 +35,7 @@ Update configuration details at config/index.js
...
}
```

For switching to EU region update the hosts at config/default.js

```js
Expand All @@ -39,17 +44,20 @@ For switching to EU region update the hosts at config/default.js
cdn: 'https://eu-cdn.contentstack.com/v3',
...
}
```
```

## Usage

After setting the configuration, you'll can run the below given commands!

1. Export all modules [ assets, locales, environments, extensions, webhooks, global_fields, content_types and entries, labels ]

```bash
$ npm run export
```

2. Export a specific module

```bash
$ npm run export-assets
$ npm run export-env
Expand All @@ -62,17 +70,20 @@ $ npm run export-entries
$ npm run export-labels

```

> Note: Before exporting entries, you must export locales, assets and content types.

> Note: If you keep the value of preserveStackVersion to true, then you will have to provide the email and password mandatorily in the config file, the management token will not work in that case.

### Known Limitations and Issues
* If 2 assets share same uid and filename, only the first version of the asset would be available
* Does not support the following
* Roles
* Users
* Releases
* Workflow

- If 2 assets share same uid and filename, only the first version of the asset would be available
- Does not support the following
- Roles
- Users
- Releases
- Workflow

## License

This project is licensed under MIT license
Loading