# chtsht

> Display or execute your own custom cheat sheet

Latest version **0.3.0** (published 2024-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install chtsht
pnpm add chtsht
yarn add chtsht
bun add chtsht
```

Provides the command `chtsht`.

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2024-01-14 |
| First published | 2022-02-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 14.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Aaron Casanova |
| Maintainers | aaronccasanova |

## Links

- npm: https://www.npmjs.com/package/chtsht
- Repository: https://github.com/aaronccasanova/aacc
- Homepage: https://github.com/aaronccasanova/aacc/blob/main/packages/chtsht/README.md
- Issues: https://github.com/aaronccasanova/aacc/issues
- npm.io page: https://npm.io/package/chtsht

## Dependencies (8)

- [ink](https://npm.io/package/ink.md) ^3.2.0
- [meow](https://npm.io/package/meow.md) ^9.0.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [execa](https://npm.io/package/execa.md) ^5.1.1
- [react](https://npm.io/package/react.md) ^17.0.0
- [prompts](https://npm.io/package/prompts.md) ^2.4.2
- [ink-table](https://npm.io/package/ink-table.md) ^3.0.0
- [ink-select-input](https://npm.io/package/ink-select-input.md) ^4.2.1

## Recent versions

- 0.3.0 (latest) — 2024-01-14
- 0.0.0-snapshot-release-20220606222633 (snapshot-release) — 2022-06-06
- 0.0.0-snapshot-release-20220606221842 — 2022-06-06
- 0.0.0-snapshot-release-20220606221703 — 2022-06-06
- 0.0.0-snapshot-release-20220606203445 — 2022-06-06
- 0.0.0-snapshot-release-20220606201401 — 2022-06-06
- 0.0.0-snapshot-release-20220606195532 — 2022-06-06
- 0.0.0-snapshot-release-20220606194720 — 2022-06-06
- 0.0.0-snapshot-release-20220602161353 — 2022-06-02
- 0.0.0-snapshot-release-20220602145506 — 2022-06-02
- 0.0.0-snapshot-release-20220602000842 — 2022-06-02
- 0.2.1 — 2022-06-01
- 0.0.0-snapshot-release-20220601232926 — 2022-06-01
- 0.0.0-snapshot-release-20220601231958 — 2022-06-01
- 0.0.0-snapshot-release-20220525140709 — 2022-05-25
- … 31 more at https://npm.io/package/chtsht/versions

## README

# CHTSHT

Display or execute your own custom cheat sheet

![chtsht-demo](https://user-images.githubusercontent.com/32409546/153777534-8903c232-a27c-47fe-bcc3-3709512b937c.gif)

## Install

```sh
npm i -g chtsht
```

## Config

Add `.chtsht` file to your home directory. e.g. `~/.chtsht`

```ts
// Config structure
type Config = {
  [cheatsheet: string]: Array<{
    description: string
    command: string
  }>
}
```

Example:

```json
{
  "npm": [
    {
      "description": "Show global packages",
      "command": "npm ls -g --depth=0"
    },
    {
      "description": "Show outdated global packages",
      "command": "npm outdated -g --depth=0"
    }
  ],
  "yarn": [
    {
      "description": "List caches",
      "command": "yarn cache list"
    },
    {
      "description": "Clean cache(s)",
      "command": "yarn cache clean <name>"
    }
  ]
}
```

> Note: `"command"` values with `<>` brackets will prompt you to input the
> enclosed value if the `--exec | -e` flag is used.

## CLI

Alternatively, you can use `npx` to use this CLI.

```
  $ chtsht --help

  Usage
    $ chtsht <name>

  Options
    --exec, -e  Execute the command

  Examples
    # Show select list of all cheat sheets
    $ chtsht

    # Show the docker cheat sheet
    $ chtsht docker

    # Execute the command
    $ chtsht -e docker
```

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