diff --git a/README.md b/README.md index 5bc5a1e..66cad63 100644 --- a/README.md +++ b/README.md @@ -64,19 +64,23 @@ $ csdx content-type:details -a "management token" -c "content type" --no-path ## `csdx content-type:audit` -display recent changes to a Content Type +Display recent changes to a Content Type ``` USAGE - $ csdx content-type:audit + $ csdx content-type:audit -c [-k | -a ] -OPTIONS - -a, --token-alias=token-alias management token alias - -c, --content-type=content-type (required) Content Type UID - -s, --stack=stack Stack UID +FLAGS + -a, --token-alias= Management token alias + -c, --content-type= (required) Content Type UID + -k, --stack= Stack API Key + +DESCRIPTION + Display recent changes to a Content Type EXAMPLES - $ csdx content-type:audit -s "xxxxxxxxxxxxxxxxxxx" -c "home_page" + $ csdx content-type:audit -k "xxxxxxxxxxxxxxxxxxx" -c "home_page" + $ csdx content-type:audit -a "management token" -c "home_page" ``` @@ -84,22 +88,27 @@ _See code: [src/commands/content-type/audit.ts](https://github.com/Contentstack- ## `csdx content-type:compare` -compare two Content Type versions +Compare two Content Type versions ``` USAGE - $ csdx content-type:compare + $ csdx content-type:compare -c [-k | -a ] [-l -r ] + +FLAGS + -a, --token-alias= Management token alias + -c, --content-type= (required) Content Type UID + -k, --stack= Stack API Key + -l, --left= Content Type version, i.e. prev version + -r, --right= Content Type version, i.e. later version -OPTIONS - -a, --token-alias=token-alias management token alias - -c, --content-type=content-type (required) Content Type UID - -l, --left=left Content Type version, i.e. prev version - -r, --right=right Content Type version, i.e. later version - -s, --stack=stack Stack UID +DESCRIPTION + Compare two Content Type versions EXAMPLES - $ csdx content-type:compare -s "xxxxxxxxxxxxxxxxxxx" -c "home_page" - $ csdx content-type:compare -s "xxxxxxxxxxxxxxxxxxx" -c "home_page" -l # -r # + $ csdx content-type:compare -k "xxxxxxxxxxxxxxxxxxx" -c "home_page" + + $ csdx content-type:compare -k "xxxxxxxxxxxxxxxxxxx" -c "home_page" -l # -r # + $ csdx content-type:compare -a "management token" -c "home_page" -l # -r # ``` @@ -111,14 +120,17 @@ compare two Content Types on different Stacks ``` USAGE - $ csdx content-type:compare-remote + $ csdx content-type:compare-remote (-o -r ) -c -OPTIONS - -c, --content-type=content-type (required) Content Type UID - -o, --origin-stack=origin-stack (required) origin Stack UID - -r, --remote-stack=remote-stack (required) remote Stack UID +FLAGS + -c, --content-type= (required) Content Type UID + -o, --origin-stack= (required) Origin Stack API Key + -r, --remote-stack= (required) Remote Stack API Key -EXAMPLE +DESCRIPTION + compare two Content Types on different Stacks + +EXAMPLES $ csdx content-type:compare-remote -o "xxxxxxxxxxxxxxxxxxx" -r "xxxxxxxxxxxxxxxxxxx" -c "home_page" ``` @@ -126,21 +138,26 @@ _See code: [src/commands/content-type/compare-remote.ts](https://github.com/Cont ## `csdx content-type:details` -display Content Type details +Display Content Type details ``` USAGE - $ csdx content-type:details + $ csdx content-type:details -c [-k | -a ] [-p] -OPTIONS - -a, --token-alias=token-alias management token alias - -c, --content-type=content-type (required) Content Type UID - -p, --[no-]path show path column - -s, --stack=stack Stack UID +FLAGS + -a, --token-alias= Management token alias + -c, --content-type= (required) Content Type UID + -k, --stack= Stack API Key + -p, --[no-]path show path column + +DESCRIPTION + Display Content Type details EXAMPLES - $ csdx content-type:details -s "xxxxxxxxxxxxxxxxxxx" -c "home_page" + $ csdx content-type:details -k "xxxxxxxxxxxxxxxxxxx" -c "home_page" + $ csdx content-type:details -a "management token" -c "home_page" + $ csdx content-type:details -a "management token" -c "home_page" --no-path ``` @@ -148,23 +165,31 @@ _See code: [src/commands/content-type/details.ts](https://github.com/Contentstac ## `csdx content-type:diagram` -create a visual diagram of a Stack's Content Types +Create a visual diagram of a Stack's Content Types ``` USAGE - $ csdx content-type:diagram + $ csdx content-type:diagram -o -d portrait|landscape -t svg|dot [-k | -a ] + +FLAGS + -a, --token-alias= Management token alias + -d, --direction=