contentstack-cli-content-type

v1.2.2

Retrieve information about Content Types in a Stack. For more information about how to use this package see README

Latest version published 4 months ago

License: MIT

NPM

GitHub

Package Health Score

59 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.2.2	\|	09/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.2	\|	10/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.8	\|	03/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (14)

GitHub Stars: 2
Forks: 3
Contributors: 10

Direct Usage Popularity

The npm package contentstack-cli-content-type receives a total of 14 downloads a week. As such, we scored contentstack-cli-content-type popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package contentstack-cli-content-type, we found that it has been starred 2 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 10
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like contentstack-cli-content-type is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 12
Last Release: 4 months ago
Last Commit: 4 months ago

Further analysis of the maintenance status of contentstack-cli-content-type based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that contentstack-cli-content-type demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=8.0.0

Age: 3 years
Dependencies: 17 Direct
Versions: 14
Install Size: 68.5 kB
Dist-tags: 1
# of Files: 39
Maintainers: 1
TS Typings: No

contentstack-cli-content-type has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Node.js CI npm

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

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.
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.
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.
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.
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.
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

How to use this plugin

This plugin requires you to be authenticated using csdx auth:login.

Several commands, such as csdx content-type:compare support token aliases as input. These token aliases should be created using csdx auth:tokens:add.

The commands only use the Stack API Key. The management token is ignored. They are provided as a convenience, so the Stack API Keys do not have to be re-typed.

Usability

The csdx content-type:details command requires a wide terminal window. If the path column is not needed, you can hide it:

$ csdx content-type:details -a "management token" -c "content type" --no-path

Commands

`csdx content-type:audit`

Display recent changes to a Content Type

USAGE
  $ csdx content-type:audit -c  [-s  | -a  | -a ] [-k  |  | ]

FLAGS
  -a, --alias=          Alias of the management token
  -a, --token-alias=    Management token alias
  -c, --content-type=   (required) Content Type UID
  -k, --stack-api-key=  Stack API Key
  -s, --stack=          Stack 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 -c  [-s  | -a ] [-k  | ] [-a ] [-l  -r ]

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

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 (-o  -r ) -c 

FLAGS
  -c, --content-type=  (required) Content Type UID
  -o, --origin-stack=  (required) Origin Stack API Key
  -r, --remote-stack=  (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 -c  [-s  | -a ] [-k  | ] [-a ] [-p]

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

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 -o  -d portrait|landscape -t svg|dot [-s  | -a  | -a ] [-k
     |  | ]

FLAGS
  -a, --alias=          Alias of the management token
  -a, --token-alias=    Management token alias
  -d, --direction=<option>     (required) [default: portrait] graph orientation
                               
  -k, --stack-api-key=  Stack API Key
  -o, --output=         (required) full path to output
  -s, --stack=          Stack UID
  -t, --type=<option>          (required) [default: svg] graph output file type
                               

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 [-s  | -a  | -a ] [-k  |  | ] [-o title|modified]

FLAGS
  -a, --alias=          Alias of the management token
  -a, --token-alias=    Management token alias
  -k, --stack-api-key=  Stack API Key
  -o, --order=<option>         [default: title] order by column
                               
  -s, --stack=          Stack UID

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

contentstack-cli-content-type dependencies

tmp axios table tslib cli-ux moment git-diff url-join diff2html @types/tmp @types/table node-graphviz @types/git-diff @types/hogan.js @types/diff2html @contentstack/cli-command @contentstack/cli-utilities

contentstack-cli-content-type development dependencies

jest oclif eslint globby ts-jest ts-node typescript @types/jest @types/node @oclif/plugin-help eslint-config-oclif eslint-config-oclif-typescript

FAQs

What is contentstack-cli-content-type?

Retrieve information about Content Types in a Stack. Visit Snyk Advisor to see a full health score report for contentstack-cli-content-type, including popularity, security, maintenance & community analysis.

Is contentstack-cli-content-type popular?

The npm package contentstack-cli-content-type receives a total of 14 weekly downloads. As such, contentstack-cli-content-type popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is contentstack-cli-content-type well maintained?

We found that contentstack-cli-content-type demonstrated a healthy version release cadence and project activity. It has a community of 10 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is contentstack-cli-content-type safe to use?

While scanning the latest version of contentstack-cli-content-type, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 3 December-2024, at 09:56 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP