ipfs / ipfs/go-ipfs-cmds

Non-optional command options surrounded with square brackets in help text

Open Beginner friendly
#71 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
52
Forks
45
PR merge metrics
No merged PRs in 30d

Description

`ipfs key gen`'s help text shows:

```
ipfs key gen [--type= | -t] [--size= | -s] [--]
```

However, `--type` and `--size` are required options (command errors out if they are not supplied). If these are intended to be required, it should probably look like:

```
ipfs key gen (--type= | -t) (--size= | -s) [--]
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the command definition or help-generation entry point for `ipfs key gen`, and inspect how required options are rendered in its usage text. Confirm the fix by checking that `--type` and `--size` appear outside square brackets and that the command still reports them as required.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.