# @estruyf/vscode-cli

> VS Code CLI to help you with extension development and documentation

Latest version **1.0.0** (published 2022-02-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @estruyf/vscode-cli
pnpm add @estruyf/vscode-cli
yarn add @estruyf/vscode-cli
bun add @estruyf/vscode-cli
```

Provides the command `vsc`.

## 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.0 |
| Published | 2022-02-01 |
| First published | 2021-09-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 49.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Elio Struyf |
| Maintainers | eliostruyf |

## Links

- npm: https://www.npmjs.com/package/@estruyf/vscode-cli
- Repository: https://github.com/estruyf/vscode-cli
- Issues: https://github.com/estruyf/vscode-cli/issues
- Funding: https://github.com/sponsors/estruyf
- npm.io page: https://npm.io/package/@estruyf/vscode-cli

## Dependencies (4)

- [arg](https://npm.io/package/arg.md) ^5.0.1
- [esm](https://npm.io/package/esm.md) 3.2.25
- [kleur](https://npm.io/package/kleur.md) 4.1.4
- [inquirer](https://npm.io/package/inquirer.md) 8.1.2

## Recent versions

- 1.0.0 (latest) — 2022-02-01
- 1.0.0-beta.5627870 (next) — 2023-07-22
- 0.0.8 — 2022-01-31
- 0.0.7 — 2022-01-31
- 0.0.6 — 2022-01-31
- 0.0.5 — 2021-09-22
- 0.0.4 — 2021-09-20
- 0.0.3 — 2021-09-20
- 0.0.1 — 2021-09-05

## README

# VS Code CLI

A VS Code CLI to help you with exporting the contribution points to `Markdown`. The CLI helps you with documenting all `commands` and `settings` of your extension.

![](./assets/help-v1.0.0.png)

## Installation

Installation from npm

```bash
npm i -g @estruyf/vscode-cli
```

## Usage

```bash
vsc <commands> <task> [options] 
```

### Commands

- `commands`: List all available commands as Markdown output.
- `settings`: List all available settings as Markdown output.

### Tasks

- `add`: Add a new command or setting.
- `export`: Export all commands or settings.
- `sort`: Sort all commands or settings.

### Options

#### Export option(s)

- `--heading`, `-h`: Specify a heading level for the output. DEFAULT: `2`

#### Command add option(s)

- `--name`, `-n`: Specify the name of the command. REQUIRED
- `--title`, `-t`: Specify the title of the command.
- `--category`, `-c`: Specify the title of the command.

#### Setting add option(s)

- `--name`, `-n`: Specify the name of the setting. REQUIRED
- `--type`: Specify the type of the setting.
- `--description`: Specify the description of the setting.

### Examples

```bash
$ vsc commands

## Command category: title

- ID: `command id`
```

```bash
$ vsc settings --heading 2

## Setting

Markdown description || description

- Type: `type`
- Default: `default`
```

```bash
$ vsc commands add --name <id of the command> --title <title of the command> --category <category of the command>
```

```bash
$ vsc settings add --name <id of the setting>
```

## License

[MIT License](./LICENSE)

[![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Festruyf%2Fvscode-cli&countColor=%23263759)](https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Festruyf%2Fvscode-cli)

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