# @comms/cli

> Comms.dev CLI

Latest version **1.0.3** (published 2022-07-17) · 0 weekly downloads

## Install

```sh
npm install @comms/cli
pnpm add @comms/cli
yarn add @comms/cli
bun add @comms/cli
```

Provides the command `comms-cli`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-07-17 |
| First published | 2022-07-12 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 136.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Bojan Rajh |
| Maintainers | schtr4jh |
| Keywords | cli, comms, comms.dev, online store |

## Links

- npm: https://www.npmjs.com/package/@comms/cli
- Repository: https://github.com/commscenter/comms-cli
- Homepage: https://comms.dev
- Issues: https://github.com/commscenter/comms-cli/issues
- npm.io page: https://npm.io/package/@comms/cli

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2022-07-17
- 1.0.2 — 2022-07-17
- 1.0.1 — 2022-07-14
- 1.0.0 — 2022-07-12

## README

# Comms CLI

Comms CLI is a set of commands using JS/Node to manipulate your [Comms.dev stores](https://comms.dev) and
[Comms Hub](https://hub.comms.dev) 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](https://supervisor.comms.dev) and [Comms Hub](https://hub.comms.dev). 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
```

# Help

See [Comms Hub kit](https://github.com/CommsCenter/Comms-Hub-kit) for more info.

---
_Source: https://npm.io/package/@comms/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._