ipfs/kubo

Document global options

Open

#2,583 opened on Apr 19, 2016

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedtopic/docs-ipfs

Description

timeout is a global option that can be passed to the CLI and to the HTTP API. It is referenced in a few places, like in ipfs diag net --help, but it isn't clear there that it is global, and it may seem that it is only relevant for those subcommands (like diag net). There should be a mention of global options, somewhere in the CLI man (and in the HTTP API docs, but we can get to that later).

The obvious place would be at the bottom of ipfs --help. What do you think?

Contributor guide

Tech stack
go
Domain
documentationcli
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of Go CLI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue requests adding a mention of global options (e.g., timeout) to the CLI help output, specifically at the bottom of 'ipfs help'. The discussion indicates that the change should be made in the help text generation code, likely in the commands package. Review the existing code for how help text is generated and add a section for global options. No existing PR is linked.