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

Better getting started tutorial? #239

Closed
joshcanhelp opened this issue Apr 9, 2024 · 1 comment · Fixed by #240
Closed

Better getting started tutorial? #239

joshcanhelp opened this issue Apr 9, 2024 · 1 comment · Fixed by #240

Comments

@joshcanhelp
Copy link

Describe the issue

I had a tough time figuring out where to start with oclif. The CLI generator created a whole project but then I was left to poke through the docs and figure out what to do next, how the flags work, etc. So I did all that and wrote a tutorial in the process:

https://www.joshcanhelp.com/oclif/

It's based on a new oclif init command that's currently in PR (oclif/oclif#1358) but, once that's merged, I think it would be a much better introduction than what's there now. You're welcome to use it as-is or with edits, Markdown is here. I would appreciate attribution, if you're willing, but not required.

@mdonnalley
Copy link
Contributor

Thanks @joshcanhelp - love the tutorial. I think there's a lot there that we can use. Once oclif/oclif#1366 is merged, I'll circle back to this.

And, yes, we'll absolutely attribute the new content to you. I'm also considering writing a blog post for oclif.io that highlights the new oclif init command. I'd give you credit there as well

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