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

nicer help? #20

Closed
jbenet opened this issue Feb 9, 2016 · 2 comments
Closed

nicer help? #20

jbenet opened this issue Feb 9, 2016 · 2 comments
Milestone

Comments

@jbenet
Copy link
Member

jbenet commented Feb 9, 2016

help should have a description of what this tool is used for, and an example. look at the man pages for wget and curl. so instead of:

Retrieve and save IPFS objects.

maybe:

ipget - retrieve and save IPFS objects

ipget is a tool for non-interactive downloading of files or objects from IPFS to the 
user's filesystem, similar to wget or curl. It supports /ipfs and /ipns paths. ipget
is meant to be used in scripts and pipelines.

or something.

@hackergrrl
Copy link
Contributor

Nice! I think you're 100% right: wget and curl do a great job in most of these regards.

I think we can do better than their usage output though -- theirs is very terse:

wget

stephen // ~ $ wget
wget: missing URL
Usage: wget [OPTION]... [URL]...

Try `wget --help' for more options.

curl:

stephen // ~ $ curl
curl: try 'curl --help' or 'curl --manual' for more information

We shouldn't mimick blindly here. I think something that offers a description like you said and common options is better usage output. This can be complemented with excellent man pages.

Let's not copy these tools' --help output though (check it out; it's a massive many-page dump). The scope of ipget shouldn't get so massive that the list of possible invocations becomes that bloated.


Summary:

  • usage output that describes the tool's use, provides an example, and describes usage
  • a great man page that gives background on IPFS, what multiaddresses are, includes full step-by-step examples, and any other context a brand new user would need to understand the tool (curl --manual does a great job; talks about what URLs are, etc)
  • should offer hooks throughout that invite the user to learn more about IPFS; act as a gateway into the IPFS community / suite of tools

@hackergrrl hackergrrl mentioned this issue Feb 12, 2016
22 tasks
@hackergrrl hackergrrl added this to the 1.0.0 milestone Sep 14, 2016
@hackergrrl hackergrrl added the status/ready Ready to be worked label Sep 15, 2016
@hackergrrl
Copy link
Contributor

Broke these out into #45 and #46.

@hackergrrl hackergrrl removed the status/ready Ready to be worked label Sep 18, 2016
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

No branches or pull requests

2 participants