@comms/cli NPM

Comms CLI

Comms CLI is a set of commands using JS/Node to manipulate your Comms.dev stores and Comms Hub shares.

Setup

Install the latest version of @comms/cli

$ npm i -g @comms/cli

Update docker image used for building assets.

$ docker pull commsdev/hub-dev:latest

Configuration

Comms CLI connects to Comms Supervisor and Comms Hub. You need to login there and get your API keys. Then you can manually login to both sites in CLI by running:

$ comms-cli auth:login

You can also skip this step and enter API keys once you'll access features for which the API keys are needed.

Your configuration will be encrypted and stored at ./.comms-cli/.

Troubleshooting

All commands will autodiscover templates in the current working directory. Shares need to be organized in ./$vendor/$type/$name/$name.vue directories/files for the autodiscovery, build and publish processes to work.

Updating `comms-cli` alias

Sometimes the comms-cli alias fails to be properly set. Update our comms-cli alias manually in our profile.

$ nano ~/.zshrc

alias comms-cli="/usr/local/lib/node_modules/@comms/cli/build/cli-linux"

Or update the symlink directly.

$ ln -sf /usr/local/lib/node_modules/@comms/cli/build/cli-linux /usr/local/bin/comms-cli

Reload the profile (or open another terminal).

$ . ~/.zshrc

Usage

Run comms-cli.

$ comms-cli

Usage: comms-cli [options] [command]

CLI for Comms.dev

Options:
  -V, --version          output the version number
  --vv, --verbose
  --vvv, --debug
  -h, --help             display help for command

Commands:
  auth
  auth:status            Print authentication status for ID, Hub, Supervisor and stores
  auth:login             Login to Comms Hub or Comms Supervisor
  auth:logout            Logout from Comms ID, Hub or Supervisor
  
  store
  store:list [options]   List my stores on Comms Supervisor
  store:status           Check store status
  store:stats            Print store stats
  store:create           Create new development or production store
  
  hub
  hub:list [options]     List my shares on Comms Hub
  hub:bootstrap          Bootstrap files for a new share
  hub:mock [options]     Virtually install local shares to the development store
  hub:serve [options]    Serve local assets to test them on the actual store
  hub:publish [options]  Publish selected shares to Comms Hub
  hub:install            Install published shares to the store
  
  self-update            Pull docker image and try to update npm package when globally installed
  help [command]         display help for command