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

shorter command-line help #297

Open
simonmichael opened this Issue Nov 15, 2015 · 2 comments

Comments

Projects
None yet
3 participants
@simonmichael
Owner

simonmichael commented Nov 15, 2015

The output of --help for most commands is larger than a standard 80x25 screen, so unless you use a tall terminal or a pager, it's likely that the bit of help you need will be offscreen most of the time. We brainstormed a few options, such as using -h and --help for shorter and longer help the way git does.


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

@simonmichael simonmichael modified the milestone: 1.0 Nov 15, 2015

@TomK32

This comment has been minimized.

Show comment
Hide comment
@TomK32

TomK32 Dec 17, 2015

Contributor

Personally I don't mind.
Look at vim --help which is just as long. ledger --help does it worse, opening the ledger man page! git --help fits my little terminal nicely, git add --help opens the man page for git-add (which is okay as it is a sub man page)

Contributor

TomK32 commented Dec 17, 2015

Personally I don't mind.
Look at vim --help which is just as long. ledger --help does it worse, opening the ledger man page! git --help fits my little terminal nicely, git add --help opens the man page for git-add (which is okay as it is a sub man page)

@silvernode

This comment has been minimized.

Show comment
Hide comment
@silvernode

silvernode Jan 30, 2017

We just have to think of what people want when they start. Reports could probably be slimmed down to 3 very commonly desired use cases and more help for the rest of the report commands mentioned conveniently just below the initial 3 report commands. Of course work on other areas can be done but this could be a good way to think. "what do people care the most about" and then just go with that.

EDIT: So I've looked at the Reporting commands in "hledger -h".

The first I thought (and probably many if not most people think) is "What's my balance?", followed by "What have I purchased?" and lastly, "Where is most of my money going?"

So the top 3 might be:
hledger bs
hledger print
hledger is

"To view additional reporting commands type _____"

That's the basic idea

silvernode commented Jan 30, 2017

We just have to think of what people want when they start. Reports could probably be slimmed down to 3 very commonly desired use cases and more help for the rest of the report commands mentioned conveniently just below the initial 3 report commands. Of course work on other areas can be done but this could be a good way to think. "what do people care the most about" and then just go with that.

EDIT: So I've looked at the Reporting commands in "hledger -h".

The first I thought (and probably many if not most people think) is "What's my balance?", followed by "What have I purchased?" and lastly, "Where is most of my money going?"

So the top 3 might be:
hledger bs
hledger print
hledger is

"To view additional reporting commands type _____"

That's the basic idea

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment