mirror of
https://github.com/ipfs/kubo.git
synced 2025-08-06 19:44:01 +08:00
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>
This commit is contained in:

committed by
Jeromy Johnson

parent
1b50a9d2a5
commit
0a45ada4ed
@ -47,16 +47,6 @@ var ObjectCmd = &cmds.Command{
|
||||
ShortDescription: `
|
||||
'ipfs object' is a plumbing command used to manipulate DAG objects
|
||||
directly.`,
|
||||
Synopsis: `
|
||||
ipfs object data <key> - Outputs raw bytes in an object
|
||||
ipfs object diff <key1> <key2> - Diffs two given objects
|
||||
ipfs object get <key> - Get the DAG node named by <key>
|
||||
ipfs object links <key> - Outputs links pointed to by object
|
||||
ipfs object new <template> - Create new ipfs objects
|
||||
ipfs object patch <args> - Create new object from old ones
|
||||
ipfs object put <data> - Stores input, outputs its key
|
||||
ipfs object stat <key> - Outputs statistics of object
|
||||
`,
|
||||
},
|
||||
|
||||
Subcommands: map[string]*cmds.Command{
|
||||
|
Reference in New Issue
Block a user