oclif / oclif

CLI for generating, building, and releasing oclif CLIs. Built by Salesforce.

Home Page:https://oclif.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Customize options for oclif readme generate

WillDelish opened this issue · comments

commented

Is your feature request related to a problem? Please describe.
I am making a CLI tool that won't be on npm (just greating tarballs), so having the npm instructions to install in the Usage section of the generated README.md creates the wrong instructions for a user

Describe the solution you'd like
I would like to have the option to remove the Ussage part of README.md or provide my own custom string.

Describe alternatives you've considered
I could try using sed command in the prepack to just remove the npm install line before executing the oclif tarballs. I've looked around the docs and I see there's a way to override the Usage section for commands, but doesn't seem like there's a way to override the npm install -g section.

the instructions for that are here:

static description = `The readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:

If you delete the
`# Usage

`

from your README you should be able to avoid that OR manually set whatever you want