Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/estruyf/vscode-cli
VS Code CLI to help you with extension development and documentation
https://github.com/estruyf/vscode-cli
cli documentation vscode vscode-extension vscode-settings
Last synced: 8 days ago
JSON representation
VS Code CLI to help you with extension development and documentation
- Host: GitHub
- URL: https://github.com/estruyf/vscode-cli
- Owner: estruyf
- License: mit
- Created: 2021-09-05T09:39:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-22T00:54:49.000Z (over 1 year ago)
- Last Synced: 2025-01-15T21:40:55.362Z (9 days ago)
- Topics: cli, documentation, vscode, vscode-extension, vscode-settings
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@estruyf/vscode-cli
- Size: 394 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
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.
## Installation
Installation from npm
```bash
npm i -g @estruyf/vscode-cli
```
## Usage
```bash
vsc [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 --title --category
```
```bash
$ vsc settings add --name
```
## License
[MIT License](./LICENSE)
[](https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Festruyf%2Fvscode-cli)