Skip to content

Improve CLI help pages #6013

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 5, 2019
Merged

Improve CLI help pages #6013

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5ed9534
Updating synopsis
AuHau Feb 22, 2019
8ffaa62
Adding information about 'ipfs log' subcommand
AuHau Feb 22, 2019
0c4c827
Add information about logging env. variables (#2692)
AuHau Feb 22, 2019
5e5c040
commands(help): remove --local and --stream-chanels options
Stebalien Mar 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions core/commands/log.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ var LogCmd = &cmds.Command{
ShortDescription: `
'ipfs log' contains utility commands to affect or read the logging
output of a running daemon.

There are also two environmental variables that direct the logging
system (not just for the daemon logs, but all commands):
IPFS_LOGGING - sets the level of verbosity of the logging. One of: debug, info, warning, error, critical
IPFS_LOGGING_FMT - sets formatting of the log output. One of: color, nocolor
`,
},

Expand Down
3 changes: 2 additions & 1 deletion core/commands/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const (
var Root = &cmds.Command{
Helptext: cmdkit.HelpText{
Tagline: "Global p2p merkle-dag filesystem.",
Synopsis: "ipfs [--config=<config> | -c] [--debug=<debug> | -D] [--help=<help>] [-h=<h>] [--local=<local> | -L] [--api=<api>] <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> ...",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Kubuxu LGTY?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, --stream-channels is an internal option isn't it?

Subcommands: `
BASIC COMMANDS
init Initialize ipfs local configuration
Expand Down Expand Up @@ -72,6 +72,7 @@ TOOL COMMANDS
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