@contentstack/cli-audit
Audit plugin
How to install this plugin
$ csdx plugins:install @contentstack/cli-audit
How to use this plugin
$ npm install -g @contentstack/cli-audit
$ csdx COMMAND
running command...
$ csdx (--version|-v)
@contentstack/cli-audit/1.3.5 linux-x64 node-v18.19.0
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
Commands
csdx audit
Perform audits and find possible errors in the exported Contentstack data
USAGE
$ csdx audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
content-types|global-fields|entries] [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv |
--no-truncate]
FLAGS
--modules=<option>... Provide the list of modules to be audited
<options: content-types|global-fields|entries>
--report-path=<value> Path to store the audit reports
COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
TABLE FLAGS
--columns=<value> Show only the specified columns (comma-separated)
--csv The output is in the CSV format [alias: --output=csv]
--filter=<value> Filter property by partial string matching. For example: name=foo
--no-truncate The output is not truncated to fit the screen
--sort=<value> Property to sort by (prepend '-' for descending)
DESCRIPTION
Perform audits and find possible errors in the exported Contentstack data
ALIASES
$ csdx audit
$ csdx cm:stacks:audit
EXAMPLES
$ csdx audit
$ csdx audit --report-path=<path>
$ csdx audit --report-path=<path> --csv
$ csdx audit --report-path=<path> --filter="name=<filter-value>"
$ csdx audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
csdx audit:fix
Perform audits and fix possible errors in the exported Contentstack data.
USAGE
$ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--fix-only
reference|global_field|json:rte|json:custom-field|blocks|group] [--columns <value> | ] [--sort <value>] [--filter
<value>] [--csv | --no-truncate]
FLAGS
--copy-dir Create backup from the original data.
--copy-path=<value> Provide the path to backup the copied data
--fix-only=<option>... Provide the list of fix options
<options: reference|global_field|json:rte|json:custom-field|blocks|group>
--modules=<option>... Provide the list of modules to be audited
<options: content-types|global-fields|entries>
--report-path=<value> Path to store the audit reports
COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
TABLE FLAGS
--columns=<value> Show only the specified columns (comma-separated)
--csv The output is in the CSV format [alias: --output=csv]
--filter=<value> Filter property by partial string matching. For example: name=foo
--no-truncate The output is not truncated to fit the screen
--sort=<value> Property to sort by (prepend '-' for descending)
DESCRIPTION
Perform audits and fix possible errors in the exported Contentstack data.
ALIASES
$ csdx audit:fix
$ csdx cm:stacks:audit:fix
EXAMPLES
$ csdx audit:fix --copy-dir
$ csdx audit:fix --report-path=<path> --copy-dir
$ csdx audit:fix --report-path=<path> --copy-dir --csv
$ csdx audit:fix --fix-only=reference,global_field --copy-dir
$ csdx audit:fix --report-path=<path> --filter="name=<filter-value>"
$ csdx audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
csdx cm:stacks:audit
Perform audits and find possible errors in the exported Contentstack data
USAGE
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
content-types|global-fields|entries] [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv |
--no-truncate]
FLAGS
--modules=<option>... Provide the list of modules to be audited
<options: content-types|global-fields|entries>
--report-path=<value> Path to store the audit reports
COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
TABLE FLAGS
--columns=<value> Show only the specified columns (comma-separated)
--csv The output is in the CSV format [alias: --output=csv]
--filter=<value> Filter property by partial string matching. For example: name=foo
--no-truncate The output is not truncated to fit the screen
--sort=<value> Property to sort by (prepend '-' for descending)
DESCRIPTION
Perform audits and find possible errors in the exported Contentstack data
ALIASES
$ csdx audit
$ csdx cm:stacks:audit
EXAMPLES
$ csdx cm:stacks:audit
$ csdx cm:stacks:audit --report-path=<path>
$ csdx cm:stacks:audit --report-path=<path> --csv
$ csdx cm:stacks:audit --report-path=<path> --filter="name=<filter-value>"
$ csdx cm:stacks:audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
See code: src/commands/cm/stacks/audit/index.ts
csdx cm:stacks:audit:fix
Perform audits and fix possible errors in the exported Contentstack data.
USAGE
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--fix-only
reference|global_field|json:rte|json:custom-field|blocks|group] [--columns <value> | ] [--sort <value>] [--filter
<value>] [--csv | --no-truncate]
FLAGS
--copy-dir Create backup from the original data.
--copy-path=<value> Provide the path to backup the copied data
--fix-only=<option>... Provide the list of fix options
<options: reference|global_field|json:rte|json:custom-field|blocks|group>
--modules=<option>... Provide the list of modules to be audited
<options: content-types|global-fields|entries>
--report-path=<value> Path to store the audit reports
COMMON FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path where the data is stored
TABLE FLAGS
--columns=<value> Show only the specified columns (comma-separated)
--csv The output is in the CSV format [alias: --output=csv]
--filter=<value> Filter property by partial string matching. For example: name=foo
--no-truncate The output is not truncated to fit the screen
--sort=<value> Property to sort by (prepend '-' for descending)
DESCRIPTION
Perform audits and fix possible errors in the exported Contentstack data.
ALIASES
$ csdx audit:fix
$ csdx cm:stacks:audit:fix
EXAMPLES
$ csdx cm:stacks:audit:fix --copy-dir
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
$ csdx cm:stacks:audit:fix --fix-only=reference,global_field --copy-dir
$ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
$ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
See code: src/commands/cm/stacks/audit/fix.ts
csdx help [COMMANDS]
Display help for csdx.
USAGE
$ csdx help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for csdx.
See code: @oclif/plugin-help
csdx plugins
List installed plugins.
USAGE
$ csdx plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ csdx plugins
See code: @oclif/plugin-plugins
csdx plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ csdx plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ csdx plugins:add
EXAMPLES
$ csdx plugins:add myplugin
$ csdx plugins:add https://github.com/someuser/someplugin
$ csdx plugins:add someuser/someplugin
csdx plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ csdx plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ csdx plugins:inspect myplugin
See code: @oclif/plugin-plugins
csdx plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ csdx plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ csdx plugins:add
EXAMPLES
$ csdx plugins:install myplugin
$ csdx plugins:install https://github.com/someuser/someplugin
$ csdx plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
csdx plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ csdx plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ csdx plugins:link myplugin
See code: @oclif/plugin-plugins
csdx plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ csdx plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ csdx plugins:unlink
$ csdx plugins:remove
EXAMPLES
$ csdx plugins:remove myplugin
csdx plugins:reset
Remove all user-installed and linked plugins.
USAGE
$ csdx plugins:reset
See code: @oclif/plugin-plugins
csdx plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ csdx plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ csdx plugins:unlink
$ csdx plugins:remove
EXAMPLES
$ csdx plugins:uninstall myplugin
See code: @oclif/plugin-plugins
csdx plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ csdx plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ csdx plugins:unlink
$ csdx plugins:remove
EXAMPLES
$ csdx plugins:unlink myplugin
csdx plugins:update
Update installed plugins.
USAGE
$ csdx plugins:update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins