Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ioncakephper/test-gen-cli-markdown
https://github.com/ioncakephper/test-gen-cli-markdown
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ioncakephper/test-gen-cli-markdown
- Owner: ioncakephper
- Created: 2024-12-22T11:57:22.000Z (16 days ago)
- Default Branch: main
- Last Pushed: 2024-12-22T12:44:15.000Z (16 days ago)
- Last Synced: 2024-12-22T13:17:54.012Z (16 days ago)
- Language: JavaScript
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Your readme
Introduction goes here...
Sample CLI with options and arguments followed by commands with their own arguments and options
**Example Usage:**
```bash
node ./src/index.js [command] [arguments] [options]
```
**Version:**
```bash
node ./src/index.js -V # or --version
```
```txt
1.0.0
```
**Help:**
```bash
node ./src/index.js -h # or --help
```
```txt
Usage: index [options] [command] [pattern...]
Sample CLI with options and arguments followed by commands with their own arguments and options
Arguments:
pattern Glob filename patterns (default: ["**/*[Oo]utline.yaml"])
Options:
-h, --help display help for command
-s, --sidebarsFilename Filename and path of sidebars filename (default: "sidebars.js")
--templates Path to templates folder (default: "templates")
-V, --version output the version number
Commands:
generate|g [options] [filename] A special command of the app to generate a file.
```
**Arguments:**
| Argument | Description | Default |
|---|---|---|
| `pattern` | Glob filename patterns | ["**/*[Oo]utline.yaml"] |
**Options:**
| Option | Value | Description | Default |
|---|---- |---|---|
| `-h, --help` | | display help for command | |
| `-s, --sidebarsFilename` | filePath | Filename and path of sidebars filename | "sidebars.js" |
| `--templates` | path | Path to templates folder | "templates" |
| `-V, --version` | | output the version number | |
## Commands
- [`generate|g` command](#generate|g-command)
### `generate|g` command
A special command of the app to generate a file.
**Example Usage:**
```bash
node ./src/index.js generate [arguments] [options]
```
**Version:**
```bash
node ./src/index.js generate -V # or --version
```
```txt
1.0.0
```
**Help:**
```bash
node ./src/index.js generate -h # or --help
```
```txt
Usage: index generate|g [options] [filename]
A special command of the app to generate a file.
Arguments:
filename Name of file to generate (default: "README.md")
Options:
--config Configuration file (default: "schema.json")
-h, --help display help for command
```
**Arguments:**
| Argument | Description | Default |
|---|---|---|
| `filename` | Name of file to generate | "README.md" |
**Options:**
| Option | Value | Description | Default |
|---|---- |---|---|
| `--config` | filename | Configuration file | "schema.json" |
| `-h, --help` | | display help for command | |