coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 10:27:46 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs: suggest dag/files cmds in place of object

Browse Source 
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
This commit is contained in:
Marcin Rataj 2021-03-24 18:02:42 +01:00
parent 0ff1cf33aa
commit 5fad09909f
No known key found for this signature in database
GPG Key ID: 222B6784D5A79E42
3 changed files with 18 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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
@ -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.

6
core/commands/object/object.go
View File

@ -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{

8
core/commands/root.go
View File

@ -32,7 +32,7 @@ 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
@ -40,10 +40,10 @@ BASIC COMMANDS
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