npm package: @setster/setster-cli
Description: Setster command line interface
Author: Setster Inc.
Latest version: 1.0.0

# Setster Command Line Interface

Setster Command Line Interface to create a new Setster Engage starter kit and also to interact with Setster from the cli

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

<!-- toc -->
* [Setster Command Line Interface](#setster-command-line-interface)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g @setster/setster-cli
$ setster-cli COMMAND
running command...
$ setster-cli (-v|--version|version)
@setster/setster-cli/1.0.0 darwin-x64 node-v14.18.1
$ setster-cli --help [COMMAND]
USAGE
  $ setster-cli COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`setster-cli autocomplete [SHELL]`](#setster-cli-autocomplete-shell)
* [`setster-cli create [PATH]`](#setster-cli-create-path)
* [`setster-cli help [COMMAND]`](#setster-cli-help-command)
* [`setster-cli remove`](#setster-cli-remove)
* [`setster-cli start`](#setster-cli-start)

## `setster-cli autocomplete [SHELL]`

display autocomplete installation instructions

```
USAGE
  $ setster-cli autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ setster-cli autocomplete
  $ setster-cli autocomplete bash
  $ setster-cli autocomplete zsh
  $ setster-cli autocomplete --refresh-cache
```

_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_

## `setster-cli create [PATH]`

Command used to create a new Setster Widget project

```
USAGE
  $ setster-cli create [PATH]

ARGUMENTS
  PATH  [default: .] The relative path to the folder where you want to create the project

OPTIONS
  -h, --help  show CLI help
```

_See code: [src/commands/create.ts](https://github.com/boxador/setster-cli/blob/v1.0.0/src/commands/create.ts)_

## `setster-cli help [COMMAND]`

display help for setster-cli

```
USAGE
  $ setster-cli 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/v3.2.3/src/commands/help.ts)_

## `setster-cli remove`

Command used to remove an existing Setster Widget project

```
USAGE
  $ setster-cli remove

OPTIONS
  -h, --help  show CLI help
```

_See code: [src/commands/remove.ts](https://github.com/boxador/setster-cli/blob/v1.0.0/src/commands/remove.ts)_

## `setster-cli start`

Command used to start an existing Setster Widget project

```
USAGE
  $ setster-cli start

OPTIONS
  -d, --developer  Use this flag to start the project in developer mode. This will allow to watch for any file changes
                   in the project and restart the project when a file changes

  -h, --help       show CLI help
```

_See code: [src/commands/start.ts](https://github.com/boxador/setster-cli/blob/v1.0.0/src/commands/start.ts)_
<!-- commandsstop -->