keybase / keybase/client

Missing CLI documentation for `keybase` command

Open
#9,656 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
9.2k
Forks
1.3k
Avg merge
12h 58m
Merged PRs (30d)
56

Description

I noticed that keybase --help doesn't list the keybase global options (like --version or --debug). And for sub commands, the flags (e.g. --number for keybase chat) only show up when you introduce a deliberate syntax error, but are omitted in keybase help chat.

Additionally, keybase does not seem to come with a man page, although this might be an issue with my distro's packaging.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the output of keybase --help, keybase help chat, and a deliberate syntax error for a subcommand. Inspect the CLI help generation and packaging entry points to determine where global and subcommand flags are documented, and check whether man-page support is handled by the project or by distro packaging. Done means the relevant help output lists the options and the man-page responsibility is clarified.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.