# config-storage-cli

> CLI application to store key-value pairs in your computer

Latest version **0.1.3** (published 2023-05-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install config-storage-cli
pnpm add config-storage-cli
yarn add config-storage-cli
bun add config-storage-cli
```

Provides the commands `csc`, `config-storage`.

## 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.1.3 |
| Published | 2023-05-26 |
| First published | 2023-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Vicente Gutiérrez |
| Maintainers | vcgtz |
| Keywords | cli, storage, nodejs, js, command, line |

## Links

- npm: https://www.npmjs.com/package/config-storage-cli
- Repository: https://github.com/vcgtz/config-storage-cli
- Homepage: https://github.com/vcgtz/config-storage-cli#readme
- Issues: https://github.com/vcgtzconfig-storage-cli/issues
- npm.io page: https://npm.io/package/config-storage-cli

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^5.2.0
- [inquirer](https://npm.io/package/inquirer.md) ^9.2.6
- [commander](https://npm.io/package/commander.md) ^10.0.1
- [clipboardy](https://npm.io/package/clipboardy.md) ^3.0.0
- [config-storage](https://npm.io/package/config-storage.md) ^2.1.3

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.1.3 (latest) — 2023-05-26
- 0.1.2 — 2023-05-26
- 0.1.1 — 2023-05-26
- 0.1.0 — 2023-05-26

## README

# Config Storage CLI
![npm](https://img.shields.io/npm/l/config-storage-cli?color=blue)
![npm](https://img.shields.io/npm/v/config-storage-cli?color=blue)

The **Config Storage CLI** is a command-line tool that allows you to store and retrieve values locally on your computer. It provides a simple and convenient way to manage key-value pairs, making it ideal for storing and accessing configuration settings, temporary data, and other types of information that you need to persist locally.

**Features:**
- Easy-to-use: The **Config Storage CLI** offers a user-friendly interface, allowing you to store and retrieve values with straightforward commands.
- Key-Value Storage: It enables you to store data using key-value pairs, making it flexible for various use cases.
- Secure Storage: Your values are stored locally on your computer, ensuring data privacy and security.

Whether you need a convenient way to store configuration settings, API keys, or any other type of data locally, **Config Storage CLI** simplifies the process and provides a reliable solution for managing your stored values.

This package is based on https://www.npmjs.com/package/config-storage.

## Installation
```bash
npm i -g config-storage-cli
```

## Usage
**Note:** You can also use `csc` instead of `config-storage`.

You can use the command `config-storage` to see all the available commands.
```text
$ config-storage

Usage: config-storage [options] [command]

CLI util to store key-value pairs in your computer

Options:
  -V, --version  output the version number
  -h, --help     display help for command

Commands:
  set            Set a key-value pair in your computer
  get            Get a stored value using a key
  delete         Delete a stored value using a key
  clean          Clean all your stored data
  list           List all your stored keys
  help           display help for command
```

### :arrow_right: `set` command
```text
config-storage set <key> <value>
```

```text
$ config-storage set hello world

The hello key was stored succesfully.
```

### :arrow_right: `get` command
```text
config-storage get <key>
```

```text
$ config-storage get hello

world
```

```text
$ config-storage get goodbye

The key 'goodbye' does not exist.
```

You can use the option `-c` to copy the stored value into your clipboard. 
```text
$ config-storage get -c hello

world
```

### :arrow_right: `delete` command
```text
$ config-storage delete hello

? Are you sure you want to delete your hello key? (y/N) y
The hello key was deleted succesfully.
```

```text
$ config-storage delete goodbye

The key 'goodbye' does not exist.
```

### :arrow_right: `list` command
```text
$ config-storage list

Stored Keys:
token_one
token_two
username_web_one
username_web_two
```

### :arrow_right: `clean` command
```text
$ config-storage clean

? Are you sure you want to delete all your stored keys? Yes
All of your data was deleted succesfully.
```

## License
[MIT](https://github.com/vcgtz/config-storage-cli/blob/main/LICENSE)

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