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

Introduce Datasource Filtering on sync command based on Name and Slug #52

Open
CaprinaeWT wants to merge 15 commits into
base: master
Choose a base branch
from
Open

Introduce Datasource Filtering on sync command based on Name and Slug #52

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
17e16af
Add Sync filters for type datasource -> --datasources-starts-with-slu…
Jun 14, 2023
d01ac4d
Update README: Add --components-groups, --datasources-starts-with-slu…
Jun 14, 2023
c7fadd6
fix: revert starts-with and filter query features
ademarCardoso Jun 28, 2023
c36b30e
fix: adding again the target space-id
ademarCardoso Jun 28, 2023
172cbf2
Merge pull request #58 from storyblok/hotfix/revert-sync-query-filter
ademarCardoso Jun 28, 2023
9e7f1e7
feat(int-978): adding default header for all requests
ademarCardoso Jul 10, 2023
2910b36
chore(int-978): bump new js-client version
ademarCardoso Jul 10, 2023
6ab33a7
feat(int-978): adding headers to the spaces command
ademarCardoso Jul 11, 2023
b032cbd
Merge pull request #60 from storyblok/feat/int-978-adding-default-header
ademarCardoso Jul 12, 2023
09c3260
Merge branch 'main'
CaprinaeWT Aug 8, 2023
b5e0a18
Add datasource filter examples
CaprinaeWT Aug 8, 2023
3ea2c53
make it possible to use the slug and name datasource filter at time
CaprinaeWT Aug 8, 2023
3ba93c7
Revert accidental format on Readme
CaprinaeWT Aug 10, 2023
d12723c
Revert accidental format on cli.js
CaprinaeWT Aug 10, 2023
cf06134
Revert accidental format on cli.js
CaprinaeWT Aug 10, 2023
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
144 changes: 77 additions & 67 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,35 +22,39 @@ $ npm i storyblok -g

## Commands


### login

Login to the Storyblok cli

```sh
$ storyblok login
```

#### Login options

##### Options for Login with email and password
* `email`: your user's email address
* `password`: your user's password

Comment thread
CaprinaeWT marked this conversation as resolved.
- `email`: your user's email address
- `password`: your user's password

##### Options for Login with token (Recomended to SSO user's but works with all user accounts)
* `token`: your personal access token

- `token`: your personal access token

**Get your personal access token**
* Go to [https://app.storyblok.com/#/me/account?tab=token](https://app.storyblok.com/#/me/account?tab=token) and click on Generate new token.

- Go to [https://app.storyblok.com/#/me/account?tab=token](https://app.storyblok.com/#/me/account?tab=token) and click on Generate new token.

**For Both login options you nedd to pass the region**

* `region`: region you would like to work in. Please keep in mind that the region must match the region of your space. You can use `us`, `cn` or `eu`, if left empty, default is `eu`. This region flag will be used for the other cli's commands.
- `region`: region you would like to work in. Please keep in mind that the region must match the region of your space. You can use `us`, `cn` or `eu`, if left empty, default is `eu`. This region flag will be used for the other cli's commands.

#### Login with token flag

You can also add the token directly from the login’s command, like the example below:

```sh
$ storyblok login --token <PERSONAL_ACCESS_TOKEN> --region eu
$ storyblok login --token <PERSONAL_ACCESS_TOKEN> --region eu
```

### logout
Expand All @@ -60,6 +64,7 @@ Logout from the Storyblok cli
```sh
$ storyblok logout
```

### user

Get the currently logged in user
Expand All @@ -68,7 +73,6 @@ Get the currently logged in user
$ storyblok user
```


### select

Usage to kickstart a boilerplate, fieldtype or theme
Expand All @@ -87,7 +91,7 @@ $ storyblok pull-languages --space <SPACE_ID>

#### Options

* `space`: your space id
- `space`: your space id

### pull-components

Expand All @@ -103,10 +107,10 @@ $ storyblok pull-components --space <SPACE_ID> --separate-files --file-name pro

#### Options

* `space`: your space id
* `separate-files`: boolean flag to save components and presets in single files instead a file with all
* `path`: the path to save your components and preset files
* `file-name`(optional): a custom filename used to generate the component and present files, default is the space id
- `space`: your space id
- `separate-files`: boolean flag to save components and presets in single files instead a file with all
- `path`: the path to save your components and preset files
- `file-name`(optional): a custom filename used to generate the component and present files, default is the space id

### push-components

Expand All @@ -118,7 +122,7 @@ $ storyblok push-components <SOURCE> --space <SPACE_ID> --presets-source <PRESET

#### Parameters

* `source`: can be a URL or path to JSON file, the path to a json file could be to a single or multiple files separated by comma, like `./pages-1234.json,../User/components/grid-1234.json`
- `source`: can be a URL or path to JSON file, the path to a json file could be to a single or multiple files separated by comma, like `./pages-1234.json,../User/components/grid-1234.json`

Using an **URL**

Expand All @@ -140,8 +144,8 @@ $ storyblok push-components ./page.json,../grid.json,./feature.json --space 6781

#### Options

* `space`: your space id
* `presets-source` (optional): it can be a URL or path to JSON file with the presets
- `space`: your space id
- `presets-source` (optional): it can be a URL or path to JSON file with the presets

#### Examples

Expand All @@ -166,14 +170,17 @@ storyblok delete-component <component> --space <SPACE_ID>
```

#### Parameters
* `component`: The name or id of the component

- `component`: The name or id of the component

#### Options
* `space_id`: the space where the command should be executed.

- `space_id`: the space where the command should be executed.

#### Examples

Delete a component on your space.

```sh
storyblok delete-component 111111 --space 67819
```
Expand All @@ -192,7 +199,8 @@ storyblok delete-components <SOURCE> --space <SPACE_ID>
```

#### Parameters
* `source`: can be a URL or path to JSON file, the path to a json file could be to a single or multiple files separated by comma, like `./pages-1234.json,../User/components/grid-1234.json`

- `source`: can be a URL or path to JSON file, the path to a json file could be to a single or multiple files separated by comma, like `./pages-1234.json,../User/components/grid-1234.json`

Using an **URL**

Expand All @@ -213,23 +221,27 @@ $ storyblok push-components ./page.json,../grid.json,./feature.json --space 6781
```

#### Options
* `space_id`: the space where the command should be executed.
* `reverse`: When passed as an argument, deletes only those components on your space that do not appear in the JSON.
* `dryrun`: when passed as an argument, does not perform any changes on the given space.

- `space_id`: the space where the command should be executed.
- `reverse`: When passed as an argument, deletes only those components on your space that do not appear in the JSON.
- `dryrun`: when passed as an argument, does not perform any changes on the given space.

#### Examples

Delete all components on a certain space that occur in your local JSON.

```sh
storyblok delete-components ./components.json --space 67819
```

Delete only those components which do not occur in your local json from your space.

```sh
storyblok delete-components ./components.json --space 67819 --reverse
```

To see the result in your console output but to not perform the command on your space, use the `--dryrun` argument.

```sh
storyblok delete-components ./components.json --space 67819 --reverse --dryrun
```
Expand All @@ -244,13 +256,12 @@ $ storyblok sync --type <COMMAND> --source <SPACE_ID> --target <SPACE_ID>

#### Options

* `type`: describe the command type to execute. Can be: `folders`, `components`, `stories`, `datasources` or `roles`. It's possible pass multiple types separated by comma (`,`).
* `source`: the source space to use to sync
* `target`: the target space to use to sync
* `starts-with`: sync only stories that starts with the given string
* `filter`: sync stories based on the given filter. Required Options: Required options: `--keys`, `--operations`, `--values`
* `keys`: Multiple keys should be separated by comma. Example: `--keys key1,key2`, `--keys key1`
* `operations`: Operations to be used for filtering. Can be: `is`, `in`, `not_in`, `like`, `not_like`, `any_in_array`, `all_in_array`, `gt_date`, `lt_date`, `gt_int`, `lt_int`, `gt_float`, `lt_float`. Multiple operations should be separated by comma.
- `type`: describe the command type to execute. Can be: `folders`, `components`, `stories`, `datasources` or `roles`. It's possible pass multiple types separated by comma (`,`).
- `source`: the source space to use to sync
- `target`: the target space to use to sync
- `components-groups`: Synchronize components based on their group UUIDs separated by commas. Example: `--components-groups ******-****`
- `datasources-starts-with-slug`: Synchronize datasources that starts with the given slug. Example: `--datasources-starts-with-slug global-translations`
- `datasources-starts-with-name`: Synchronize datasources that starts with the given name. Example: `--datasources-starts-with-name Translations`

#### Examples

Expand All @@ -261,14 +272,15 @@ $ storyblok sync --type components --source 00001 --target 00002
# Sync components and stories from `00001` space to `00002` space
$ storyblok sync --type components,stories --source 00001 --target 00002

# Sync only stories that starts with `myStartsWithString` from `00001` space to `00002` space
$ storyblok sync --type stories --source 00001 --target 00002 --starts-with myStartsWithString
# Synchronize components based on their group UUIDs separated by commas
$ storyblok sync --type components --source 00001 --target 00002 --components-groups xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

# Sync only stories with a category field like `reference` from `00001` space to `00002` space
$ storyblok sync --type stories --source 00001 --target 00002 --filter --keys category --operations like --values reference
# Synchronize datasources that starts with the given slug
$ storyblok sync --type datasources --source 00001 --target 00002 --datasources-starts-with-slug global-translations

# Synchronize datasources that starts with the given name (input is converted to lowercase)
$ storyblok sync --type datasources --source 00001 --target 00002 --datasources-starts-with-name Global Translations

# Sync only stories with a category field like `reference` and a name field not like `demo` from `00001` space to `00002` space
$ storyblok sync --type stories --source 00001 --target 00002 --filter --keys category,name --operations like,not_like --values reference,demo
```

### quickstart
Expand All @@ -286,13 +298,14 @@ Create a migration file (with the name `change_<COMPONENT>_<FIELD>.js`) inside t
```sh
$ storyblok generate-migration --space <SPACE_ID> --component <COMPONENT_NAME> --field <FIELD>
```

It's important to note that the `component` and `field` parameters are required and must be spelled exactly as they are in Storyblok. You can check the exact name by looking at the `Block library` inside your space.

#### Options

* `space`: space where the component is
* `component`: component name. It needs to be a valid component
* `field`: name of field
- `space`: space where the component is
- `component`: component name. It needs to be a valid component
- `field`: name of field

### run-migration

Expand All @@ -310,15 +323,15 @@ $ storyblok run-migration --publish published --space 1234 --component article -

#### Options

* `space`: the space you get from the space settings area
* `component`: component name. It needs to be a valid component
* `field`: name of field
* `dryrun`: when passed as an argument, does not perform the migration
* `publish` (optional): publish the content when update
* `all`: publish all stories, even if they have not yet been published
* `published`: only publish stories that already are published and don't have unpublished changes
* `published-with-changes`: publish stories that are published and have unpublished changes
* `publish-languages` (optional): publish specific languages. You can publish more than one language at a time by separating the languages by `,`
- `space`: the space you get from the space settings area
- `component`: component name. It needs to be a valid component
- `field`: name of field
- `dryrun`: when passed as an argument, does not perform the migration
- `publish` (optional): publish the content when update
- `all`: publish all stories, even if they have not yet been published
- `published`: only publish stories that already are published and don't have unpublished changes
- `published-with-changes`: publish stories that are published and have unpublished changes
- `publish-languages` (optional): publish specific languages. You can publish more than one language at a time by separating the languages by `,`

### rollback-migration

Expand All @@ -332,13 +345,12 @@ $ storyblok rollback-migration --space 1234 --component Product --field title

#### options

* `space`: the space you get from the space settings area
* `component`: component name. It needs to be a valid component
* `field`: name of field
- `space`: the space you get from the space settings area
- `component`: component name. It needs to be a valid component
- `field`: name of field

### spaces


List all spaces of the logged account

```sh
Expand Down Expand Up @@ -380,7 +392,7 @@ this-is-my-title;This is my title;"Lorem ipsum dolor sit amet";https://a.storybl
A json file need to have following format:

```json
[
[
{
"path": "this-is-my-title",
"title": "This is my title",
Expand All @@ -393,11 +405,11 @@ A json file need to have following format:

#### Options

* `file`: name of the file
* `type`: name of the content type you want to use for the import
* `space`: id of your space
* `delimiter` (optional): delimiter of the `.cvs` files, only necessary if you are uploading a csv file (Default value is **;** )
* `folder` (optional): id of the folder where you want to store the content in Storyblok
- `file`: name of the file
- `type`: name of the content type you want to use for the import
- `space`: id of your space
- `delimiter` (optional): delimiter of the `.cvs` files, only necessary if you are uploading a csv file (Default value is **;** )
- `folder` (optional): id of the folder where you want to store the content in Storyblok

### Help

Expand Down Expand Up @@ -445,10 +457,9 @@ The created file will have the following content:
module.exports = function (block) {
// Example to change a string to boolean
// block.subtitle = !!(block.subtitle)

// Example to transfer content from other field
// block.subtitle = block.other_field
}
};
```

In the migration function you can manipulate the block variable to add or modify existing fields of the component.
Expand Down Expand Up @@ -508,8 +519,8 @@ Then let's update the default image field:

```js
module.exports = function (block) {
block.image = block.image.replace('a.storyblok.com', 'my-custom-domain.com')
}
block.image = block.image.replace("a.storyblok.com", "my-custom-domain.com");
};
```

Now you can execute the migration file:
Expand All @@ -520,7 +531,6 @@ $ storyblok run-migration --space 00000 --component product --field image --dryr

#### 2. Transform a Markdown field into a Richtext field


To transform a markdown or html field into a richtext field you first need to install a converter library.

```sh
Expand All @@ -533,16 +543,16 @@ Now check the path to the global node modules folder
$ npm root -g
```

Generate the migration with ```storyblok generate-migration --space 00000 --component blog --field intro``` and apply the transformation:
Generate the migration with `storyblok generate-migration --space 00000 --component blog --field intro` and apply the transformation:

```js
var richtextConverter = require('/usr/local/lib/node_modules/storyblok-markdown-richtext')
var richtextConverter = require("/usr/local/lib/node_modules/storyblok-markdown-richtext");

module.exports = function (block) {
if (typeof block.intro == 'string') {
block.intro = richtextConverter.markdownToRichtext(block.intro)
if (typeof block.intro == "string") {
block.intro = richtextConverter.markdownToRichtext(block.intro);
}
}
};
```

## You're looking for a headstart?
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"p-series": "^2.1.0",
"path": "^0.12.7",
"simple-uuid": "^0.0.1",
"storyblok-js-client": "^4.5.6",
"storyblok-js-client": "^5.12.0",
"update-notifier": "^5.1.0",
"xml-js": "^1.6.11"
},
Expand All @@ -65,4 +65,4 @@
"master"
]
}
}
}
Loading