# @rhcp/cli

> A command line interface for SPAship!

Latest version **0.3.2** (published 2019-10-21) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

Provides the command `spaship`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2019-10-21 |
| First published | 2019-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 7 |
| Unpacked size | 11.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | mclayton@redhat.com |
| Maintainers | kmoore, kylebuch8, markcaron, mwcz |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@rhcp/cli
- Repository: https://github.com/spaship/cli
- Issues: https://github.com/spaship/cli/issues
- npm.io page: https://npm.io/package/@rhcp/cli

## Dependencies (7)

- [execa](https://npm.io/package/execa.md) ^2.1.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.0
- [@rhcp/common](https://npm.io/package/@rhcp/common.md) ^0.3.1
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.13.3
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.5.19
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^2.2.1

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

- 0.3.2 (latest) — 2019-10-21
- 0.3.1 — 2019-10-21
- 0.2.0 — 2019-10-18

## README

# @spaship/cli

A command line interface for SPAship.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@spaship/cli.svg)](https://npmjs.org/package/@spaship/cli)
[![Downloads/week](https://img.shields.io/npm/dw/@spaship/cli.svg)](https://npmjs.org/package/@spaship/cli)
[![License](https://img.shields.io/npm/l/@spaship/cli.svg)](https://github.com/spaship/cli/blob/master/package.json)

<!-- toc -->
* [@spaship/cli](#spashipcli)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g @rhcp/cli
$ spaship COMMAND
running command...
$ spaship (-v|--version|version)
@rhcp/cli/0.3.2 linux-x64 node-v11.14.0
$ spaship --help [COMMAND]
USAGE
  $ spaship COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`spaship deploy ARCHIVE`](#spaship-deploy-archive)
* [`spaship help [COMMAND]`](#spaship-help-command)
* [`spaship init`](#spaship-init)

## `spaship deploy ARCHIVE`

deploy to a SPAship host

```
USAGE
  $ spaship deploy ARCHIVE

ARGUMENTS
  ARCHIVE  SPA archive file

OPTIONS
  -r, --ref=ref  [default: undefined] a version tag, commit hash, or branch to identify this release

DESCRIPTION
  Send an archive containing a SPA to a SPAship host for deployment.  Supports .tar.gz/.tgz, .zip, and .tar.bz2.
```

_See code: [src/commands/deploy.js](https://github.com/spaship/cli/blob/v0.3.2/src/commands/deploy.js)_

## `spaship help [COMMAND]`

display help for spaship

```
USAGE
  $ spaship help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.1/src/commands/help.ts)_

## `spaship init`

Initialize a SPAship config file for your app.

```
USAGE
  $ spaship init

OPTIONS
  -n, --name=name    (required) a human-friendly title for your app
  -p, --path=path    (required) the URL path for your app under the SPAship domain. ex: /my/app
  -s, --[no-]single  route all non-asset requests to index.html
  --overwrite        overwrite existing spaship.yaml

DESCRIPTION
  Without arguments, init will ask you a few questions and generate a spaship.yaml config file.  The answers can also be 
  passed in as CLI options.
```

_See code: [src/commands/init.js](https://github.com/spaship/cli/blob/v0.3.2/src/commands/init.js)_
<!-- commandsstop -->

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