CLI subcommand discrepancies
- Dominant language
- Go
- Stars
- 17k
- Forks
- 2.1k
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 105
Description
Over the years a number of features have been added to Nomad and hence the Nomad CLI - this has resulted in a number discrepancies in the subcommands used for the nomad CLI but perhaps it is time to consolidate this into a more ... coherent ... experience :innocent:
Even as a looooong time user I keep stumbling over what I have outlined below :
### list vs status vs info
The `nomad namepace` and `nomad quota` commands use `list` for displaying a list of items and ` status `to get detailed information for a specific item.
The `nomad service `, `nomad volume` and `nomad acl` commands use `list` for displaying a list of items and ` info `to get detailed information for a specific item.
`nomad job` however just uses `status` to display a list and `status `to get detailed information for a specific item.
### run vs apply vs create
`nomad job` uses `run` to create or update an item, `nomad namespace` uses `create` to create or update an item, `nomad acl policy` uses `apply` to create or update an item whereas `nomad acl token` use `create` to create or update an item.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by comparing the `nomad namespace`, `quota`, `service`, `volume`, `acl`, and `job` command entry points, focusing on their `list`, `status`, `info`, `run`, `apply`, and `create` subcommands. The issue does not choose a target convention, so first establish the intended consistent behavior; done means the discrepancies are resolved across the affected CLI commands.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100