Skip to content

Commit

Permalink
Lock file and readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
@antonyagustine
antonyagustine committed Oct 5, 2023
1 parent ade4992 commit c4ca3e1
Show file tree
Hide file tree
Showing 3 changed files with 161 additions and 72 deletions.
25 changes: 1 addition & 24 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

81 changes: 48 additions & 33 deletions packages/contentstack-audit/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,28 +30,24 @@ USAGE

# Commands
<!-- commands -->
- [@contentstack/cli-audit](#contentstackcli-audit)
- [How to install this plugin](#how-to-install-this-plugin)
- [How to use this plugin](#how-to-use-this-plugin)
- [Commands](#commands)
- [`csdx audit`](#csdx-audit)
- [`csdx audit:fix`](#csdx-auditfix)
- [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
- [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
- [`csdx help [COMMANDS]`](#csdx-help-commands)
- [`csdx plugins`](#csdx-plugins)
- [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin)
- [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
- [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin-1)
- [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin)
- [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin)
- [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-1)
- [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-2)
- [`csdx plugins:update`](#csdx-pluginsupdate)
* [`csdx audit`](#csdx-audit)
* [`csdx audit:fix`](#csdx-auditfix)
* [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
* [`csdx help [COMMANDS]`](#csdx-help-commands)
* [`csdx plugins`](#csdx-plugins)
* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin)
* [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin-1)
* [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin)
* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin)
* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-1)
* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-2)
* [`csdx plugins:update`](#csdx-pluginsupdate)

## `csdx audit`

Audit and find possible errors in the exported data
Perform audits and find possible errors in the exported Contentstack data

```
USAGE
Expand All @@ -62,9 +58,17 @@ USAGE
FLAGS
-c, --config=<value> Path of the external config.
-d, --data-dir=<value> Path where the data is stored.
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--modules=<option>... Provide the list of modules to be audited.
<options: content-types|global-fields|entries>
--no-truncate do not truncate output to fit screen
--report-path=<value> Path to store the audit reports.
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Audit and find possible errors in the exported data
Perform audits and find possible errors in the exported Contentstack data
ALIASES
$ csdx audit
Expand Down Expand Up @@ -93,18 +97,18 @@ USAGE
[--filter <value>] [--csv | --no-truncate]
FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Path and location where data is stored
-c, --config=<value> Path of the external config.
-d, --data-dir=<value> Path where the data is stored.
-y, --yes Use this flag to skip confirmation
--backup-dir=<value> Provided path to backup original data
--columns=<value> only show provided columns (comma-separated)
--copy-dir Create backup from original data
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--modules=<option>... Provide list of modules to be audited
--modules=<option>... Provide the list of modules to be audited.
<options: content-types|global-fields|entries>
--no-truncate do not truncate output to fit screen
--report-path=<value> Path to store the audit reports
--report-path=<value> Path to store the audit reports.
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Expand All @@ -128,7 +132,7 @@ EXAMPLES

## `csdx cm:stacks:audit`

Audit and find possible errors in the exported data
Perform audits and find possible errors in the exported Contentstack data

```
USAGE
Expand All @@ -149,7 +153,7 @@ FLAGS
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Audit and find possible errors in the exported data
Perform audits and find possible errors in the exported Contentstack data
ALIASES
$ csdx audit
Expand Down Expand Up @@ -182,6 +186,17 @@ USAGE
FLAGS
-c, --config=<value> Path of the external config.
-d, --data-dir=<value> Path where the data is stored.
-y, --yes Use this flag to skip confirmation
--backup-dir=<value> Provided path to backup original data
--columns=<value> only show provided columns (comma-separated)
--copy-dir Create backup from original data
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--modules=<option>... Provide the list of modules to be audited.
<options: content-types|global-fields|entries>
--no-truncate do not truncate output to fit screen
--report-path=<value> Path to store the audit reports.
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Audit and fix possible errors in the exported data
Expand Down Expand Up @@ -222,7 +237,7 @@ DESCRIPTION
Display help for csdx.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.19/src/commands/help.ts)_
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_

## `csdx plugins`

Expand All @@ -245,7 +260,7 @@ EXAMPLES
$ csdx plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/index.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/index.ts)_

## `csdx plugins:install PLUGIN...`

Expand Down Expand Up @@ -310,7 +325,7 @@ EXAMPLES
$ csdx plugins:inspect myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/inspect.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/inspect.ts)_

## `csdx plugins:install PLUGIN...`

Expand Down Expand Up @@ -350,7 +365,7 @@ EXAMPLES
$ csdx plugins:install someuser/someplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/install.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/install.ts)_

## `csdx plugins:link PLUGIN`

Expand Down Expand Up @@ -379,7 +394,7 @@ EXAMPLES
$ csdx plugins:link myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/link.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/link.ts)_

## `csdx plugins:uninstall PLUGIN...`

Expand Down Expand Up @@ -427,7 +442,7 @@ ALIASES
$ csdx plugins:remove
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/uninstall.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/uninstall.ts)_

## `csdx plugins:uninstall PLUGIN...`

Expand Down Expand Up @@ -468,5 +483,5 @@ DESCRIPTION
Update installed plugins.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/update.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/update.ts)_
<!-- commandsstop -->
Loading

0 comments on commit c4ca3e1

Please sign in to comment.