CLI: print help when the user just does `openfn`
Open
Nobody has claimed this yet.
DevX
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 23
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 17
Description
Right now we throw an error if the user types openfn. Not so cool.
We should display a special help/welcome screen which:
- Prints the version number
- Prints how to run
execute, maybe with an example - Prints how to run
deploy, maybe with an example - Prints how to get more help
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the CLI command handling for an invocation with no arguments and inspect how help is currently rendered for execute and deploy. Add the welcome output with the version, example usage for execute and deploy, and a route to more help. Done means running openfn no longer throws and displays all four requested sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100