Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

unclear docs on 'single' / 'simple' CLI usage #998

Closed
techieshark opened this issue Oct 12, 2022 · 1 comment · Fixed by oclif/oclif.github.io#180
Closed

unclear docs on 'single' / 'simple' CLI usage #998

techieshark opened this issue Oct 12, 2022 · 1 comment · Fixed by oclif/oclif.github.io#180

Comments

@techieshark
Copy link

Do you want to request a feature or report a bug?

Docs bug

What is the current behavior?

Not clear how to use oclif generate to make a a CLI with just one top level command.

What is the expected behavior?

Somewhere it should be documented how to generate a CLI that has just one (top level) command that takes some options.

For example, I'm hoping to do

$ oclif generate ...

and then I'd expect that src/index.ts says

export {run} from '@oclif/core' // or something like this, as it does now

but instead of the commands/ directory, we would have ___ (what? this is where I'm unclear)

@mdonnalley
Copy link
Contributor

@techieshark This use case was addressed in oclif/core#426. But I agree that the docs are not clear about it. I'll make a note to update the docs this week

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants