wtc-cms-cli

CLI for working with the WTC CMS

• wtc-cms-cli
• Usage
• Commands

Usage

$ npm install -g @wethecurious/wtc-cms-cli
$ wtc-cms-cli COMMAND
running command...
$ wtc-cms-cli (-v|--version|version)
@wethecurious/wtc-cms-cli/0.2.3 darwin-x64 node-v10.15.2
$ wtc-cms-cli --help [COMMAND]
USAGE
  $ wtc-cms-cli COMMAND
...

Commands

• wtc-cms-cli archive-cms-content
• wtc-cms-cli generate-info-file TARGETDIR
• wtc-cms-cli help [COMMAND]
• wtc-cms-cli update-cms-types
• wtc-cms-cli update-dependency
• wtc-cms-cli validate-bucket-urls

wtc-cms-cli archive-cms-content

Downloads all CMS data for archive purposes.

USAGE
  $ wtc-cms-cli archive-cms-content

OPTIONS
  -e, --envPath=envPath            (required) relative path to env file with Amplify details
  -h, --help                       show CLI help

  -o, --outputFolder=outputFolder  (required) relative or absolute path to output folder. A subfolder will be created in
                                   here for each exhibit

DESCRIPTION
  Top tip: If you have all wtc apps in a single folder, grab data for everything in one go. First `cd THIS_REPO` then:
     `find ~/git/wtc-apps -name .env.local -exec wtc-cms-cli archive-cms-content -e {} -o /Users/ben/Desktop/CMSContent 
  \; ` \\; ;

     Note: For determining the size of videos (optional), you need to have `ffprobe` installed (usually distributed with 
  ffmpeg)

wtc-cms-cli generate-info-file TARGETDIR

Generate info.json file for auto updater script in exhibit projects

USAGE
  $ wtc-cms-cli generate-info-file TARGETDIR

ARGUMENTS
  TARGETDIR  directory containing the build

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  Pass a target directory as a parameter
  The target directory should be a build folder inside a git repository

wtc-cms-cli help [COMMAND]

display help for wtc-cms-cli

USAGE
  $ wtc-cms-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

wtc-cms-cli update-cms-types

Generates appContent.types.ts and appContentSchema.json files for a given Exhibit on the CMS

USAGE
  $ wtc-cms-cli update-cms-types

OPTIONS
  -c, --contentPath=contentPath  (required) relative path to folder to generate appContent.types.ts and
                                 appContentSchema.json

  -e, --envPath=envPath          (required) relative path to env file with Amplify details

  -h, --help                     show CLI help

  --exclude=exclude              Exclude any keys that match the given regex. Example: `--exclude "item_\w+_.*"` will
                                 remove keys such as `item_fish_title` but not `item_data`

wtc-cms-cli update-dependency

Updates an npm dependency, checks things look ok, then pushes direct to 'develop'.

USAGE
  $ wtc-cms-cli update-dependency

OPTIONS
  -d, --dependency=dependency  (required) dependency to update use [NAME]@[VERSION], e.g.
                               @wethecurious/[email protected]

  -h, --help                   show CLI help

  -p, --path=path              (required) path to exhibit folder of exhibit to upgrade

DESCRIPTION
  Top tip: If you have all wtc apps in a single folder, run for everything in one go. First `cd THIS_REPO` then:
     `find . -name "exhibit" -d -maxdepth 3 -exec wtc-cms-cli update-dependency -p {} -d 
  @wethecurious/[email protected] \; ` \\; ;

wtc-cms-cli validate-bucket-urls

Validates REACT_APP_BUCKET_URL for exhibits.

USAGE
  $ wtc-cms-cli validate-bucket-urls

OPTIONS
  -h, --help         show CLI help
  -i, --input=input  (required) path of exhibit folder

DESCRIPTION
  Top tip: If you have all wtc apps in a single folder, check everything in one go. First `cd THIS_REPO` then:
     `find ~/git/wtc-apps -name exhibit -type d -exec wtc-cms-cli validate-bucket-urls -i {} \; `