Comments (3)
There is a help
command that is build into the library, although it would be nice to have help flags handled automagically as well. I'm going to keep this issue around and work on it soon.
Thanks for submitting the issue :)
from cli.
Yeah, I started out by defining the help flag in help.go (next to the automagic version), and then special casing it by calling showAppHelp, or some such, after a check for the GlobalBool just before the version processing, but it was messy, and I don't really want to be customising cli if I can help it. I understand you have the help command, which I guess is aimed at providing help for other sub commands. In my case, I have no subcommands (although I may add some in this or other apps), and so the default behaviour is just for the process to start.
All I was after was the auto-generated help and exit when people do the ubiquitous -h/ --help. Having to do " help" is surprising for most users - especially as -h/ --help do nothing (if you override the default top level action) so you don't get to see that there even /is/ a help command. Perhaps you could even expose something like that showAppHelp in the public cli API with an optional message which gives people the ability to invoke it at will with contextual information for the user.
Just some thoughts. Anywho, thanks for the package =]
from cli.
Handling -h / --help should be pretty easy. Right now I think the flags package hijacks it but it shouldn't be too hard to trigger trigger the help action when those flags are present.
I will start working on this sometime tomorrow.
Thanks
Sent from my iPhone
On Jul 23, 2013, at 9:10 PM, Sam Duncan [email protected] wrote:
Yeah, I started out by defining the help flag in help.go (next to the automagic version), and then special casing it by calling showAppHelp, or some such, after a check for the GlobalBool just before the version processing, but it was messy, and I don't really want to be customising cli if I can help it. I understand you have the help command, which I guess is aimed at providing help for other sub commands. In my case, I have no subcommands (although I may add some in this or other apps), and so the default behaviour is just for the process to start.
All I was after was the auto-generated help and exit when people do the ubiquitous -h/ --help. Having to do " help" is surprising for most users - especially as -h/ --help do nothing (if you override the default top level action) so you don't get to see that there even /is/ a help command. Perhaps you could even expose something like that showAppHelp in the public cli API with an optional message which gives people the ability to invoke it at will with contextual information for the user.
Just some thoughts. Anywho, thanks for the package =]
—
Reply to this email directly or view it on GitHub.
from cli.
Related Issues (20)
- Shell completion requires double TAB on first usage HOT 5
- Shell completion is suggesting aliases HOT 2
- How to use a custom CLI flag separator HOT 8
- Wrong help output when a Command has "HideHelpCommand=true" but no defined subcommands
- DefaultCommand does not work when defined on a sub-Command HOT 9
- subcommand help did show global options. HOT 1
- How do I define Usage for BoolWithInverseFlag? HOT 23
- Shell completions are broken when login shell is different than currently active shell
- Use mkdocs `mike` for multi-version docs
- Strictly limit default dependencies to stdlib HOT 6
- Build out all of the v3 documentation
- Vendor usage of `github.com/xrash/smetrics` for suggestions HOT 2
- Delete stale branches HOT 5
- Use gofumpt
- Man page generation feature is not documented anywhere HOT 3
- Doc generation default value set by environment variable HOT 4
- Expose shell completions scripts in by default in the `completion` command HOT 5
- More powerful shell completion HOT 2
- Ensure `go mod tidy` works as expected HOT 1
- Target `stable` and `oldstable` in main CI
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cli.