linode / linode/linode-cli

[Feature]: sort command-line options in help output

Open
#650 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
442
Forks
159
Avg merge
7d 21h
Merged PRs (30d)
8

Description

### Description

When running `-h` to view available options, it would be useful if the options were sorted alphabetically. That makes it a lot easier to find an option one is looking for.

### Potential Usage Example

```
$ linode-cli linodes create -h
[...]
options:
-h, --help show this help message and exit
--authorized_keys authorized_keys
--authorized_users authorized_users
--backup_id backup_id
--backups_enabled backups_enabled
--booted booted
--firewall_id firewall_id
--group group
--image image
--interfaces interfaces
--interfaces.active active
--interfaces.ip_ranges ip_ranges
--interfaces.ipam_address ipam_address
--interfaces.ipv4.nat_1_1 nat_1_1
--interfaces.ipv4.vpc vpc
--interfaces.label label
--interfaces.primary primary
--interfaces.purpose purpose
--interfaces.subnet_id subnet_id
--label label
--metadata.user_data user_data
--private_ip private_ip
--region region
--root_pass [ROOT_PASS]
--stackscript_data stackscript_data
--stackscript_id stackscript_id
--swap_size swap_size
--tags tags
--type type
$
```

(Likewise for all other cli tools.)

Contributor guide

Open the contributing guide

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 locating the code that generates help output for linode-cli commands, then run `linode-cli linodes create -h` to reproduce the current ordering. Apply the alphabetical ordering consistently to the other CLI tools and verify their help output matches the requested ordering.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.