docs: suggest dag/files cmds in place of object
This is a cosmetic change to 'ipfs --help' that reorders operations to prioritize 'dag' and 'files' over legacy 'object'. Context: https://github.com/ipfs/go-ipfs/issues/7936
Marcin Rataj committed
Mar 24, 2021 at 18:02 UTC
5fad09909f7152b96bc180aeb6dcec1dd91ddfdd
3 files changed
+18
-11
README.md
+11
-4
@@ -296,18 +296,23 @@ SUBCOMMANDS
296
refs <ref> List hashes of links from an object
297
298
DATA STRUCTURE COMMANDS
299
+ dag Interact with IPLD DAG nodes
300
+ files Interact with files as if they were a unix filesystem
301
+ object Interact with objects (deprecated, use 'dag' or 'files')
302
block Interact with raw blocks in the datastore
300
- object Interact with raw dag nodes
301
- files Interact with objects as if they were a unix filesystem
303
304
ADVANCED COMMANDS
305
daemon Start a long-running daemon process
306
mount Mount an IPFS read-only mount point
307
resolve Resolve any type of name
307
- name Publish or resolve IPNS names
308
+ name Publish and resolve IPNS names
309
+ key Create and list IPNS name keypairs
310
dns Resolve DNS links
311
pin Pin objects to local storage
310
- repo Manipulate an IPFS repository
312
+ repo Manipulate the IPFS repository
313
+ stats Various operational stats
314
+ p2p Libp2p stream mounting
315
+ filestore Manage the filestore (experimental)
316
317
NETWORK COMMANDS
318
id Show info about IPFS peers
@@ -322,6 +327,8 @@ SUBCOMMANDS
327
version Show IPFS version information
328
update Download and apply go-ipfs updates
329
commands List all available commands
330
+ cid Convert and discover properties of CIDs
331
+ log Manage and show logs of running daemon
332
333
Use 'ipfs <command> --help' to learn more about each command.
334
core/commands/object/object.go
+3
-3
@@ -48,10 +48,10 @@ const (
48
49
var ObjectCmd = &cmds.Command{
50
Helptext: cmds.HelpText{
51
- Tagline: "Interact with IPFS objects.",
51
+ Tagline: "Interact with objects (deprecated, use 'dag' or 'files')",
52
ShortDescription: `
53
-'ipfs object' is a plumbing command used to manipulate DAG objects
54
-directly.`,
53
+'ipfs object' is a legacy plumbing command used to manipulate DAG objects
54
+directly. Deprecated, use more modern 'ipfs dag' and 'ipfs files' instead.`,
55
},
56
57
Subcommands: map[string]*cmds.Command{
core/commands/root.go
+4
-4
@@ -32,7 +32,7 @@ var Root = &cmds.Command{
32
Synopsis: "ipfs [--config=<config> | -c] [--debug | -D] [--help] [-h] [--api=<api>] [--offline] [--cid-base=<base>] [--upgrade-cidv0-in-output] [--encoding=<encoding> | --enc] [--timeout=<timeout>] <command> ...",
33
Subcommands: `
34
BASIC COMMANDS
35
- init Initialize ipfs local configuration
35
+ init Initialize local IPFS configuration
36
add <path> Add a file to IPFS
37
cat <ref> Show IPFS object data
38
get <ref> Download IPFS objects
@@ -40,10 +40,10 @@ BASIC COMMANDS
40
refs <ref> List hashes of links from an object
41
42
DATA STRUCTURE COMMANDS
43
+ dag Interact with IPLD DAG nodes
44
+ files Interact with files as if they were a unix filesystem
45
+ object Interact with objects (deprecated, use 'dag' or 'files')
46
block Interact with raw blocks in the datastore
44
- object Interact with raw dag nodes
45
- files Interact with objects as if they were a unix filesystem
46
- dag Interact with IPLD documents (experimental)
47
48
ADVANCED COMMANDS
49
daemon Start a long-running daemon process