1
0
mirror of https://github.com/ipfs/kubo.git synced 2025-08-06 19:44:01 +08:00

31 Commits

Author SHA1 Message Date
7470ae5428 Sort SUBCOMMANDS section of help output
License: MIT
Signed-off-by: Yuval Langer <yuval.langer@gmail.com>
2016-07-22 00:19:26 +03:00
1c0f18dfed Add default true options handling
License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@protonmail.ch>
2016-06-28 19:51:56 +02:00
d9d0446d45 Remove new line after synopsis section
As synopsis is only one line long it is overkill

License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@protonmail.ch>
2016-06-28 19:51:56 +02:00
206529730a Add Synopsis autogenerator
Generates synopsis automagically

License: MIT
Signed-off-by: Jakub Sztandera <kubuxu@protonmail.ch>
2016-06-28 19:51:56 +02:00
4489021fff Show Synopsis in long help
I think that this is useful, even though it is also shown in the Arguments and Options section below. What do you think, @noffle?

License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
2016-05-12 14:09:16 -04:00
0a45ada4ed CLI: discoverability and consistency (#2542)
* reduces help indent from 4 to 2 spaces

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* reduces horz/vert space taken by "ipfs" cmd

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* show subcommands on shorthelp

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Drops colons at the end of cmd headings.

This makes command headings consistent with the output of 'ipfs', which
does not include colons.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* more consistent output between short-/long-help

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Puts DESCRIPTION before SUBCOMMANDS.

Users likely want to understand what a command does before worrying
about its subcommands.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Keeps ipfs cmd from outputting its subcmds twice.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant synopsis from "file"

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes extra whitespace from longhelp

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Consistent spacing whether SUBCMDS or not.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant SUBCMD output from ipfs object.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant synopsis from "name"

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Newline after Description only if it exists.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant synopsis from "bootstrap"

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant synopsis from "swarm"

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes trailing newline in ping help.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Prints shorthelp on parse error.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* tiny comment fixes

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* updates README usage

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Don't include extra whitespace if no .MoreHelp

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* description improvements

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Hides the obscure 'file' subcommand.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Splits 'ipfs daemon' into Short and Long help.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes redundant synopsis from "config"

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Wraps lines to keep from going over 80.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* specify repo separately

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* s/structure/hierarchy

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* missing .

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes trailing colon from 'usage' test.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Updates sharness test error messages.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes trailing colon from 'usage' test.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Updates add-symlink to use /bin/sh.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Removes "hierarchy".

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>

* Updates "ipfs ping" synopsis.

* Updates t0040 with latest wording.

* Removes unnecessary daemon setup.

License: MIT
Signed-off-by: Stephen Whitmore <noffle@ipfs.io>
2016-04-28 14:08:32 -07:00
e78305546c gofmt 2015-04-28 16:18:26 -07:00
f168539030 Improve command line parsing 2015-04-27 17:19:38 +00:00
bf22aeec0a Reorged imports from jbenet/go-ipfs to ipfs/go-ipfs
- Modified Godeps/Godeps.json by hand
- [TEST] Updated welcome docs hash to sharness
- [TEST] Updated contact doc
- [TEST] disabled breaking test (t0080-repo refs local)
2015-03-31 12:52:25 -07:00
69ce2940a8 commands/cli: Fixed helptext option type 2014-11-19 00:54:59 -08:00
bbf3a1f4d4 commands: Changed Option to an interface 2014-11-19 00:24:55 -08:00
288ee753c0 Remove 'SYNOPSIS' from short help text
It takes some space and it looks like it
applies to the description too.

License: MIT
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
2014-11-17 21:08:56 +01:00
589851fb4e cmds: root: fix '--help' notice for subcmds 2014-11-15 09:04:49 -08:00
81b3680908 cmds2: aligned subcmd text 2014-11-14 03:20:05 -08:00
646920b0dd commands: Got rid of old helptext fields, use HelpText struct fields in helptext generator 2014-11-14 03:20:05 -08:00
27b9aec370 style(commands/cli/helptext) use helper function to cut down on
boilerplate

I know you'll love this one @mappum

License: MIT
Signed-off-by: Brian Tiger Chow <brian@perfmode.com>
2014-11-14 03:20:04 -08:00
3352aeee15 cmds2: fixed show help on root + noncallable 2014-11-14 03:20:02 -08:00
3e7592f2cc commands/cli: Sort options by length when generating options helptext 2014-11-14 03:20:02 -08:00
b836e72aea cmd2 align arguments properly 2014-11-14 03:20:00 -08:00
c0b3b43773 cmds2/helptext moved indent + tagline in subcmd 2014-11-14 03:20:00 -08:00
80d743541e commands/cli: Fixed spacing error 2014-11-14 03:20:00 -08:00
ef4480fe6d cmds/config: better help text 2014-11-14 03:20:00 -08:00
fc7c199d6a cmds/helptext: indent + newlines + synopsis 2014-11-14 03:20:00 -08:00
8aa532fbc9 commands/cli: Less line breaks in autogenerated formatting 2014-11-14 03:20:00 -08:00
c25bf522d6 newline in short helptext 2014-11-14 03:19:59 -08:00
47987f5df5 commands/cli: Transitionary commit - Generate helptext from HelpText fields if they aren't empty 2014-11-14 03:19:59 -08:00
93c69a83e8 commands/cli: Added short help text function 2014-11-14 03:17:41 -08:00
4970d8b5a3 commands/cli: Use template for helptext generation 2014-11-14 03:17:41 -08:00
7666f8880c commands: Allow overriding helptext sections with hand-written strings 2014-11-14 03:17:41 -08:00
c827573e32 commands/cli: Helptext spacing fix for root command output 2014-11-14 03:17:33 -08:00
c169fca5a2 commands/cli: Added a helptext generator 2014-11-14 03:17:33 -08:00