# @nickspencer2/chord-cli

> CLI for the chord (https://github.com/nickspencer2/chord) project.

Latest version **1.0.4** (published 2019-06-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nickspencer2/chord-cli
pnpm add @nickspencer2/chord-cli
yarn add @nickspencer2/chord-cli
bun add @nickspencer2/chord-cli
```

Provides the commands `chord-cli`, `@nickspencer2/chord-cli`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2019-06-22 |
| First published | 2019-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 13.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nick Spencer |
| Maintainers | nickspencer2 |
| Keywords | chord, cli, chord-cli |

## Links

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

## Dependencies (5)

- [esm](https://npm.io/package/esm.md) ^3.2.25
- [ncp](https://npm.io/package/ncp.md) ^2.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^6.3.1
- [nunjucks](https://npm.io/package/nunjucks.md) ^3.2.0
- [commander](https://npm.io/package/commander.md) ^2.20.0

## 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.4 (latest) — 2019-06-22
- 1.0.3 — 2019-06-21
- 1.0.2 — 2019-06-21
- 1.0.1 — 2019-06-21
- 1.0.0 — 2019-06-21

## README

# Chord CLI

## What is this?
`chord-cli` is a project I created to make using the [chord](https://github.com/nickspencer2/chord) project
easy by providing a command line interface for common tasks. 

## How do I install it?
To install this tool, from your terminal run 
```
npm install @nickspencer2/chord-cli
```

Check that installation was successful by running
```
chord-cli version
```

You should see something like
```
chord-cli version: 1.0.0
```

## How do I use it?
Once you've installed `chord-cli`, you can use its subcommands from your terminal.
The available subcommands are: 

### Commands Table
| Subcommand                     | Description                                       |
| ------------------------------ | ------------------------------------------------- |
| [version](#version-subcommand) | outputs the installed version of chord-cli        |
| [setup](#setup-subcommand)     | generates the required configuration for chord    |
| [command](#command-subcommand) | creates the required code for a new chord command |

## Subcommands
Each subcommand can be used like this from your terminal:
```
chord-cli <subcommand> <arguments>
```

### Arguments
The arguments for a subcommand can be passed by either long form, e.g. `chord-cli setup --outputDirectory myproject`
or short form, e.g. `chord-cli setup -o myproject`. If arguments are not provided on the command line, `chord-cli`
will interactively prompt for the desired values.

The flag string for each command (i.e. `--outputDirectory` and `-o` for setup) is generated by taking the field name 
as the long form (i.e. `outpuDirectory` becomes `--outputDirectory`) and the first letter of the field name as the 
short form (i.e. `outputDirectory` becomes `-o`). If two fields begin with the same letter, the first field takes 
precedence. (i.e. for setup, `-d` refers to the `discordToken` field, not the `defaultVolume` field).

#### Version Subcommand
*Description*

Outputs the installed version of chord-cli.

*Arguments*

No arguments required.

#### Setup Subcommand
*Description*

Generates the required configuration for chord.

*Arguments*

| Name                   | Long Hand               | Short Hand              |
| ---------------------- | ----------------------- | ----------------------- |
| discordToken           | `--discordToken`        | `-d`                    |
| youtubeKey             | `--youtubeKey`          | `-y`                    |
| prefix                 | `--prefix`              | `-p`                    |
| defaultVolume          | `--defaultVolume`       | None                    |
| outputDirectory        | `--outputDirectory`     | `-o`                    |
| owner                  | `--owner`               | None                    | 

#### Command Subcommand
*Description*

Creates the required code for a new chord command.

*Arguments*

| Name                   | Long Hand               | Short Hand              |
| ---------------------- | ----------------------- | ----------------------- |
| label                  | `--label`               | `-l`                    |
| descriptionString      | `--descriptionString`   | `-d`                    |
| usageString            | `--usageString`         | `-u`                    | 
| permissions            | `--permissions`         | `-p`                    | 
| outputDirectory        | `--outputDirectory`     | `-o`                    | 
| type                   | `--type`                | `-t`                    |

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