Skip to content

Commit

Permalink
updated lock and readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
shafeeqd959 committed Dec 6, 2023
1 parent bdae538 commit b40b691
Show file tree
Hide file tree
Showing 14 changed files with 181 additions and 239 deletions.
6 changes: 3 additions & 3 deletions package-lock.json

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

31 changes: 13 additions & 18 deletions packages/contentstack-auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,14 @@ It is Contentstack’s CLI plugin to perform authentication-related activities.
[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)

<!-- toc -->

- [@contentstack/cli-auth](#contentstackcli-auth)
- [Usage](#usage)
- [Commands](#commands)
* [@contentstack/cli-auth](#contentstackcli-auth)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->

```sh-session
$ npm install -g @contentstack/cli-auth
$ csdx COMMAND
Expand All @@ -26,23 +24,21 @@ USAGE
$ csdx COMMAND
...
```

<!-- usagestop -->

# Commands

<!-- commands -->

- [`csdx auth:login`](#csdx-authlogin)
- [`csdx auth:logout`](#csdx-authlogout)
- [`csdx auth:tokens`](#csdx-authtokens)
- [`csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]`](#csdx-authtokensadd--a-value---delivery---management--e-value--k-value--y---token-value)
- [`csdx auth:tokens:remove`](#csdx-authtokensremove)
- [`csdx auth:whoami`](#csdx-authwhoami)
- [`csdx login`](#csdx-login)
- [`csdx logout`](#csdx-logout)
- [`csdx tokens`](#csdx-tokens)
- [`csdx whoami`](#csdx-whoami)
* [`csdx auth:login`](#csdx-authlogin)
* [`csdx auth:logout`](#csdx-authlogout)
* [`csdx auth:tokens`](#csdx-authtokens)
* [`csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]`](#csdx-authtokensadd--a-value---delivery---management--e-value--k-value--y---token-value)
* [`csdx auth:tokens:remove`](#csdx-authtokensremove)
* [`csdx auth:whoami`](#csdx-authwhoami)
* [`csdx login`](#csdx-login)
* [`csdx logout`](#csdx-logout)
* [`csdx tokens`](#csdx-tokens)
* [`csdx whoami`](#csdx-whoami)

## `csdx auth:login`

Expand Down Expand Up @@ -328,5 +324,4 @@ ALIASES
EXAMPLES
$ csdx auth:whoami
```

<!-- commandsstop -->
13 changes: 4 additions & 9 deletions packages/contentstack-bootstrap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,24 @@ Contentstack CLI’s “Bootstrap” plugin enables you to automate the process
This means that all the required steps such as stack, environment, and content type creation, entry and asset publishing are performed just by using a single command.

<!-- toc -->

- [Usage](#usage)
- [Commands](#commands)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->

```sh-session
$ npm install -g @contentstack/cli-cm-bootstrap
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-cm-bootstrap/1.7.0 darwin-arm64 node-v20.8.0
@contentstack/cli-cm-bootstrap/1.7.1 darwin-arm64 node-v20.8.0
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
```

<!-- usagestop -->

```sh-session
Expand All @@ -39,8 +36,7 @@ USAGE
# Commands

<!-- commands -->

- [`csdx cm:bootstrap`](#csdx-cmbootstrap)
* [`csdx cm:bootstrap`](#csdx-cmbootstrap)

## `csdx cm:bootstrap`

Expand Down Expand Up @@ -78,5 +74,4 @@ EXAMPLES
```

_See code: [src/commands/cm/bootstrap.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-bootstrap/src/commands/cm/bootstrap.ts)_

<!-- commandsstop -->
21 changes: 8 additions & 13 deletions packages/contentstack-branches/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ It is Contentstack’s CLI plugin to compare and merge content.
[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)

<!-- toc -->

- [@contentstack/cli-cm-branches](#contentstackcli-cm-branches)
- [Usage](#usage)
- [Commands](#commands)
* [@contentstack/cli-cm-branches](#contentstackcli-cm-branches)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

For switching to EU region update the hosts at config/default.js
Expand All @@ -33,7 +32,6 @@ For switching to AZURE-NA region update the hosts at config/default.js
# Usage

<!-- usage -->

```sh-session
$ npm install -g @contentstack/cli-cm-branches
$ csdx COMMAND
Expand All @@ -45,18 +43,16 @@ USAGE
$ csdx COMMAND
...
```

<!-- usagestop -->

# Commands

<!-- commands -->

- [`csdx cm:branches`](#csdx-cmbranches)
- [`csdx cm:branches:create`](#csdx-cmbranchescreate)
- [`csdx cm:branches:delete [-uid <value>] [-k <value>]`](#csdx-cmbranchesdelete--uid-value--k-value)
- [`csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value)
- [`csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]`](#csdx-cmbranchesmerge--k-value--compare-branch-value---no-revert---export-summary-path-value---use-merge-summary-value---comment-value---base-branch-value)
* [`csdx cm:branches`](#csdx-cmbranches)
* [`csdx cm:branches:create`](#csdx-cmbranchescreate)
* [`csdx cm:branches:delete [-uid <value>] [-k <value>]`](#csdx-cmbranchesdelete--uid-value--k-value)
* [`csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value)
* [`csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]`](#csdx-cmbranchesmerge--k-value--compare-branch-value---no-revert---export-summary-path-value---use-merge-summary-value---comment-value---base-branch-value)

## `csdx cm:branches`

Expand Down Expand Up @@ -226,5 +222,4 @@ EXAMPLES
```

_See code: [src/commands/cm/branches/merge.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/merge.ts)_

<!-- commandsstop -->
Loading

0 comments on commit b40b691

Please sign in to comment.