https://github.com/withfig/oclif-plugin

Generate CLI skeleton from the oclif's internal representation
https://github.com/withfig/oclif-plugin

Last synced: 3 days ago
JSON representation

Generate CLI skeleton from the oclif's internal representation

• Host: GitHub
• URL: https://github.com/withfig/oclif-plugin
• Owner: withfig
• Created: 2021-04-29T22:47:26.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-10T21:34:28.000Z (about 3 years ago)
• Last Synced: 2024-04-16T00:18:10.640Z (7 months ago)
• Language: TypeScript
• Size: 43 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
fig-oclif-plugin

================

Export a Fig completion spec generated using the oclif internal representation.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

# Setup

1. Add the [@oclif/plugins-plugin](https://github.com/oclif/plugin-plugins). (This is only necessary for developement and does not need to be included in production).

> First add the plugin to your project with `yarn add @oclif/plugin-plugins`, then add it to the package.json of the oclif CLI:

>

> ```json

> {

>  "name": "mycli",

>  "version": "0.0.0",

>  "oclif": {

>    "plugins": ["@oclif/plugin-help", "@oclif/plugin-plugins"]

>  }

> }

> ```

2. Clone this repo and then inside of it run `your-cli-name plugins:link`. This will add the `fig-completion` command to `your-cli-name`.

3. Run `your-cli-name fig-completion -o output-file-name`. (The correct file extension will be added automatically)