# help-cli

> Do you often forget the different options and flags of various cli tools?

Latest version **1.0.0** (published 2023-07-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install help-cli
pnpm add help-cli
yarn add help-cli
bun add help-cli
```

Provides the command `help-cli`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-07-01 |
| First published | 2023-07-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM |
| Node | >=16.0.0 |
| Dependencies | 15 |
| Unpacked size | 27.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | alexkrkn |

## Links

- npm: https://www.npmjs.com/package/help-cli
- npm.io page: https://npm.io/package/help-cli

## Dependencies (15)

- [ink](https://npm.io/package/ink.md) ^4.2.0
- [conf](https://npm.io/package/conf.md) ^11.0.1
- [meow](https://npm.io/package/meow.md) ^12.0.1
- [axios](https://npm.io/package/axios.md) ^1.4.0
- [json5](https://npm.io/package/json5.md) ^2.2.3
- [react](https://npm.io/package/react.md) ^18.2.0
- [dedent](https://npm.io/package/dedent.md) ^0.7.0
- [marked](https://npm.io/package/marked.md) ^5.1.0
- [openai](https://npm.io/package/openai.md) ^3.2.1
- [clipboardy](https://npm.io/package/clipboardy.md) ^3.0.0
- [ink-spinner](https://npm.io/package/ink-spinner.md) ^5.0.0
- [marked-mangle](https://npm.io/package/marked-mangle.md) ^1.0.1
- [ink-text-input](https://npm.io/package/ink-text-input.md) ^5.0.1
- [marked-terminal](https://npm.io/package/marked-terminal.md) ^5.2.0
- [marked-gfm-heading-id](https://npm.io/package/marked-gfm-heading-id.md) ^3.0.4

## Recent versions

- 1.0.0 (latest) — 2023-07-01

## README

# help-cli

Do you often forget the different options and flags of various cli tools?

`help-cli` is a cli tool to help you come up with the exact cli commands.

You enter a description of what you want to accomplish, and it will use GPT to generate the exact command and explain it to you.

It is open source, and uses your own OpenAI key.

## Install

`$ npm i -g help-cli`

On first run, it will ask you for your OpenAI api key.

## Usage

run:

`$ help-cli`

## More Options

Reset your config file, so that the initial setup will run again:

`$ help-cli --reset`

See where on your system the config file was stored:

`$ help-cli --config`

## Developing

Install dependencies:

`$ npm i`

To run the dev build locally (with sourcemaps):

`$ npm start`

To run the production build:

`$ npm run build`

## License

MIT

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