Skip to content

Commit

Permalink
docs: suggest dag/files cmds in place of object
Browse files Browse the repository at this point in the history
This is a cosmetic change to 'ipfs --help' that
reorders operations to prioritize 'dag' and 'files' over legacy 'object'.

Context: #7936
  • Loading branch information
lidel committed Mar 24, 2021
1 parent 0ff1cf3 commit 5fad099
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 11 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,18 +296,23 @@ SUBCOMMANDS
refs <ref> List hashes of links from an object
DATA STRUCTURE COMMANDS
dag Interact with IPLD DAG nodes
files Interact with files as if they were a unix filesystem
object Interact with objects (deprecated, use 'dag' or 'files')
block Interact with raw blocks in the datastore
object Interact with raw dag nodes
files Interact with objects as if they were a unix filesystem
ADVANCED COMMANDS
daemon Start a long-running daemon process
mount Mount an IPFS read-only mount point
resolve Resolve any type of name
name Publish or resolve IPNS names
name Publish and resolve IPNS names
key Create and list IPNS name keypairs
dns Resolve DNS links
pin Pin objects to local storage
repo Manipulate an IPFS repository
repo Manipulate the IPFS repository
stats Various operational stats
p2p Libp2p stream mounting
filestore Manage the filestore (experimental)
NETWORK COMMANDS
id Show info about IPFS peers
Expand All @@ -322,6 +327,8 @@ SUBCOMMANDS
version Show IPFS version information
update Download and apply go-ipfs updates
commands List all available commands
cid Convert and discover properties of CIDs
log Manage and show logs of running daemon
Use 'ipfs <command> --help' to learn more about each command.
Expand Down
6 changes: 3 additions & 3 deletions core/commands/object/object.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ const (

var ObjectCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Interact with IPFS objects.",
Tagline: "Interact with objects (deprecated, use 'dag' or 'files')",
ShortDescription: `
'ipfs object' is a plumbing command used to manipulate DAG objects
directly.`,
'ipfs object' is a legacy plumbing command used to manipulate DAG objects
directly. Deprecated, use more modern 'ipfs dag' and 'ipfs files' instead.`,
},

Subcommands: map[string]*cmds.Command{
Expand Down
8 changes: 4 additions & 4 deletions core/commands/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,18 @@ var Root = &cmds.Command{
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> ...",
Subcommands: `
BASIC COMMANDS
init Initialize ipfs local configuration
init Initialize local IPFS configuration
add <path> Add a file to IPFS
cat <ref> Show IPFS object data
get <ref> Download IPFS objects
ls <ref> List links from an object
refs <ref> List hashes of links from an object
DATA STRUCTURE COMMANDS
dag Interact with IPLD DAG nodes
files Interact with files as if they were a unix filesystem
object Interact with objects (deprecated, use 'dag' or 'files')
block Interact with raw blocks in the datastore
object Interact with raw dag nodes
files Interact with objects as if they were a unix filesystem
dag Interact with IPLD documents (experimental)
ADVANCED COMMANDS
daemon Start a long-running daemon process
Expand Down

0 comments on commit 5fad099

Please sign in to comment.