directus-sync-cli

directus-sync-cli

directus-sync-cli Preset CLI

• Usage
• Commands

Usage

$ npm install -g directus-sync-cli
$ directus-sync-cli COMMAND
running command...
$ directus-sync-cli (--version)
directus-sync-cli/0.0.5 darwin-x64 node-v14.19.0
$ directus-sync-cli --help [COMMAND]
USAGE
  $ directus-sync-cli COMMAND
...

Commands

• directus-sync-cli env add
• directus-sync-cli env list
• directus-sync-cli env remove
• directus-sync-cli help [COMMAND]
• directus-sync-cli status
• directus-sync-cli sync presets
• directus-sync-cli sync schema

directus-sync-cli env add

Add a directus configuration

USAGE
  $ directus-sync-cli env add -n <value> -u <value> -t <value> [-c] [-o]

FLAGS
  -c, --[no-]check     Force adding environment without verification
  -n, --name=<value>   (required) Name of the directus environment
  -o, --override       Force updating an existing environment
  -t, --token=<value>  (required) Access token of the directus
  -u, --url=<value>    (required) Base url of the directus

DESCRIPTION
  Add a directus configuration

EXAMPLES
  $ directus-sync-cli env add -n <NAME> -u <URL> -t <TOKEN>

  $ directus-sync-cli env add -n <NAME> -u <URL> -t <TOKEN> --no-check

directus-sync-cli env list

List all saved directus configs

USAGE
  $ directus-sync-cli env list

DESCRIPTION
  List all saved directus configs

EXAMPLES
  $ directus-sync-cli list

directus-sync-cli env remove

Remove one or all directus config

USAGE
  $ directus-sync-cli env remove [-a | -n <value>]

FLAGS
  -a, --all           Remove all configurations
  -n, --name=<value>  Remove one configuration

DESCRIPTION
  Remove one or all directus config

EXAMPLES
  $ directus-sync-cli env remove -a

  $ directus-sync-cli env remove -n <NAME>

directus-sync-cli help [COMMAND]

Display help for directus-sync-cli.

USAGE
  $ directus-sync-cli help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for directus-sync-cli.

See code: @oclif/plugin-help

directus-sync-cli status

Get the status for an environment

USAGE
  $ directus-sync-cli status [-n <value>] [-d]

FLAGS
  -d, --detailed      Get services status of one configuration
  -n, --name=<value>  Get the status of one configuration

DESCRIPTION
  Get the status for an environment

EXAMPLES
  $ directus-sync-cli status

  $ directus-sync-cli status -n <NAME>

  $ directus-sync-cli status -d -n <NAME>

See code: dist/commands/status/index.ts

directus-sync-cli sync presets

Sync presets between multiple environment.

USAGE
  $ directus-sync-cli sync presets -o <value> -t <value> [-f]

FLAGS
  -f, --force           Force flag if the version are not identical
  -o, --origin=<value>  (required) Name of the configuration to use as base for export
  -t, --to=<value>      (required) Name of the configuration to use as target for export

DESCRIPTION
  Sync presets between multiple environment.

  The token must be an admin token.

  Process of the command:

  - Get the presets on the origin environment, with user email and name of the role of the preset if specified.

  - Find matching uuid of the users / role on the target environment because it could not be the same.

  - Get the presets of the target environment

  - Delete presets that match the pair (uuid,collection) to avoid conflicts or if global preset, (user: null,collection)

  - Create presets in the target environment.



EXAMPLES
  $ directus-sync-cli sync presets -o <origin> -t <target>

  $ directus-sync-cli sync presets -o <origin> -t <target> --force

directus-sync-cli sync schema

Sync schema between multiple environment

USAGE
  $ directus-sync-cli sync schema -o <value> -t <value> [-f]

FLAGS
  -f, --force           Force flag if the version are not identical
  -o, --origin=<value>  (required) Name of the configuration to use as base for export
  -t, --to=<value>      (required) Name of the configuration to use as target for export

DESCRIPTION
  Sync schema between multiple environment

EXAMPLES
  $ directus-sync-cli sync schema -o <origin> -t <target>

  $ directus-sync-cli sync schema -o <origin> -t <target> --force