FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

cli-plugins/packages/contentstack-content-type at main · contentstack/cli-plugins · GitHub

/ cli-plugins Public

Breadcrumbs

  1. cli-plugins
  2. packages

contentstack-content-type

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

Breadcrumbs

  1. cli-plugins
  2. packages

contentstack-content-type

README.md

Description

This is a plugin for Contentstack's CLI. It allows you to quickly retrieve information about Content Types in a Stack.

Why use this plugin

  1. The csdx content-type:audit command lists recent changes to a content type and by whom. This is useful when needing to find Content Type versions to compare with csdx content-type:compare. Audit logs are stored for 90 days within Contentstack.

  2. The csdx content-type:compare-remote command allows you to compare the same Content Type between two Stacks. This is useful when you have cloned or duplicated a Stack, and want to check what has changed in a child Stack.

  3. The csdx content-type:compare command allows you to compare multiple versions of a Content Type within a single Stack. This is useful when you are working in a development team, and want to compare changes made by colleagues.

  4. The csdx content-type:list command is useful when you want to see all the Content Types within a Stack. The Content Type's Display Name, UID, Last Modified Date, and Version number is shown. The list can be ordered by title or modified date. When developing against Contentstack, Content Type UIDs are needed when requesting data.

  5. The csdx content-type:details command provides useful information, such as:

    • Field UID and Data Types
    • Referenced Content Types
    • Options such as required, multiple, and unique
    • The full path to a field, useful when using the include reference endpoint or filtering operations, such as the equality endpoint.

  6. The csdx content-type:diagram command creates a visual representation of a Stack's content model.

    • The ouput format can be either svg or dot.
    • The diagram's orientation can be changed, using the -d landscape|portrait flag.
    • GraphViz is the layout engine. You can export the generated DOT Language source, using the -t dot flag.

How to install this plugin

$ csdx plugins:install contentstack-cli-content-type
$ npm install -g contentstack-cli-content-type
$ csdx COMMAND
running command...
$ csdx (--version)
contentstack-cli-content-type/2.0.0 darwin-arm64 node-v22.21.1
$ csdx --help [COMMAND]
USAGE
  $ csdx COMMAND
...

Commands

csdx content-type:audit

Display recent changes to a Content Type

USAGE
  $ csdx content-type:audit --content-type <value> [-k <value> | -a <value>]

FLAGS
  -a, --alias=<value>          Alias of the management token
  -k, --stack-api-key=<value>  Stack API Key
      --content-type=<value>   (required) Content Type UID

DESCRIPTION
  Display recent changes to a Content Type

EXAMPLES
  $ csdx content-type:audit --stack-api-key "xxxxxxxxxxxxxxxxxxx" --content-type "home_page"

  $ csdx content-type:audit --alias "management token" --content-type "home_page"

See code: src/commands/content-type/audit.ts

csdx content-type:compare

Compare two Content Type versions

USAGE
  $ csdx content-type:compare --content-type <value> [-k <value> | -a <value>] [--left <value> --right <value>]

FLAGS
  -a, --alias=<value>          Alias of the management token
  -k, --stack-api-key=<value>  Stack API Key
      --content-type=<value>   (required) Content Type UID
      --left=<value>           Content Type version, i.e. prev version
      --right=<value>          Content Type version, i.e. later version

DESCRIPTION
  Compare two Content Type versions

EXAMPLES
  $ csdx content-type:compare --stack-api-key "xxxxxxxxxxxxxxxxxxx" --content-type "home_page"

  $ csdx content-type:compare --stack-api-key "xxxxxxxxxxxxxxxxxxx" --content-type "home_page" --left # --right #

  $ csdx content-type:compare --alias "management token" --content-type "home_page" --left # --right #

See code: src/commands/content-type/compare.ts

csdx content-type:compare-remote

compare two Content Types on different Stacks

USAGE
  $ csdx content-type:compare-remote (--origin-stack <value> --remote-stack <value>) --content-type <value>

FLAGS
  --content-type=<value>  (required) Content Type UID
  --origin-stack=<value>  (required) Origin Stack API Key
  --remote-stack=<value>  (required) Remote Stack API Key

DESCRIPTION
  compare two Content Types on different Stacks

EXAMPLES
  $ csdx content-type:compare-remote --origin-stack "xxxxxxxxxxxxxxxxxxx" --remote-stack "xxxxxxxxxxxxxxxxxxx" --content-type "home_page"

See code: src/commands/content-type/compare-remote.ts

csdx content-type:details

Display Content Type details

USAGE
  $ csdx content-type:details --content-type <value> [-k <value> | -a <value>] [--path]

FLAGS
  -a, --alias=<value>          Alias of the management token
  -k, --stack-api-key=<value>  Stack API Key
      --content-type=<value>   (required) Content Type UID
      --[no-]path              show path column

DESCRIPTION
  Display Content Type details

EXAMPLES
  $ csdx content-type:details --stack-api-key "xxxxxxxxxxxxxxxxxxx" --content-type "home_page"

  $ csdx content-type:details --alias "management token" --content-type "home_page"

  $ csdx content-type:details --alias "management token" --content-type "home_page" --no-path

See code: src/commands/content-type/details.ts

csdx content-type:diagram

Create a visual diagram of a Stack's Content Types

USAGE
  $ csdx content-type:diagram --output <value> --direction portrait|landscape --type svg|dot [-k <value> | -a <value>]

FLAGS
  -a, --alias=<value>          Alias of the management token
  -k, --stack-api-key=<value>  Stack API Key
      --direction=<option>     (required) [default: portrait] graph orientation
                               <options: portrait|landscape>
      --output=<value>         (required) full path to output
      --type=<option>          (required) [default: svg] graph output file type
                               <options: svg|dot>

DESCRIPTION
  Create a visual diagram of a Stack's Content Types

EXAMPLES
  $ csdx content-type:diagram --stack-api-key "xxxxxxxxxxxxxxxxxxx" --output "content-model.svg"

  $ csdx content-type:diagram --alias "management token" --output "content-model.svg"

  $ csdx content-type:diagram --alias "management token" --output "content-model.svg" --direction "landscape"

  $ csdx content-type:diagram --alias "management token" --output "content-model.dot" --type "dot"

See code: src/commands/content-type/diagram.ts

csdx content-type:list

List all Content Types in a Stack

USAGE
  $ csdx content-type:list [-k <value> | -a <value>] [--order title|modified]

FLAGS
  -a, --alias=<value>          Alias of the management token
  -k, --stack-api-key=<value>  Stack API Key
      --order=<option>         [default: title] order by column
                               <options: title|modified>

DESCRIPTION
  List all Content Types in a Stack

EXAMPLES
  $ csdx content-type:list --stack-api-key "xxxxxxxxxxxxxxxxxxx"

  $ csdx content-type:list --alias "management token"

  $ csdx content-type:list --alias "management token" --order modified

See code: src/commands/content-type/list.ts

Back | FazBrowse Home | New Git URL