Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

CLI command naming is inconsistent

Aperta
  • Qualcosa non va?
#41 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
38/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
javascript
Ambito
cli, documentation

Direzione di ricerca

Inizia esaminando le implementazioni dei comandi CLI, in particolare il routing manuale delle istanze e lib/commands/stack/local-setup.js, quindi confronta i pattern dei comandi elencati. Controlla il README e il comportamento esistente di --help; il lavoro è concluso quando le convenzioni sono concordate, instance usa i subcommands, php-logs è deprecato e la documentazione riflette le modifiche accettate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

to refine

As the CLI has grown, naming patterns have diverged. This tracks the inconsistencies so we can agree on conventions going forward.

Two patterns for multi-action resource commands

Some resources use a single command with as a positional arg:

app variables <list|get|set|delete> [app]
app domains <list|add|remove|retry> [app]
app ip-list <get|set> [app]
app ua-blocklist <get|set> [app]
app tasks [list|cancel|logs]
Others use separate named commands per operation:

app deploy (create) vs app deploys (list)
app build (create) vs app builds (list)
app backup (create) vs app backups (list)
These are equivalent patterns for the same kind of CRUD operation.

Action vocabulary isn't standardised

add vs create, remove vs delete, set vs update are used interchangeably across commands with no rule for which to pick.

instance uses a non-standard flat positional chain

instance [group] [action] [id] [value]
All other commands use yargs subcommands. The instance routing is manual if/else, which breaks per-subcommand --help and causes the target argument to shift position:

instance info — id is in the action slot
instance access list — id is in the id slot

php-logs is redundant

stack php-logs duplicates app logs --type php. The dedicated command adds noise.

build-cache only accepts one value

build-cache requires a positional action but only accepts clear. It should just be build-cache clear.

local-setup is undocumented

lib/commands/stack/local-setup.js exists but is not listed in the README. Either document it or remove it.
Mark php-logs as deprecated

For Altis Team Use

Acceptance Criteria
  • Agree on a standard CRUD pattern (suggest: plural noun + action subcommand - deploys list, deploys create)
  • Agree on action vocabulary (list, get, create, update, delete, with add/remove only for membership)
  • Refactor instance to use proper yargs subcommands
  • Document agreed conventions in README or CONTRIBUTING
  • Mark php-logs as deprecated
Ready for Work Checklist

Is this ticket ready to be worked on? See
the Play Book Definition of Ready

  • Is the title clear?
  • Is the description clear and detailed enough?
  • Are acceptance criteria listed?
  • Have any dependencies been identified? (Optional)
  • Have any documentation/playbook changes been identified? (Optional)
  • Is an estimate or time box assigned?
  • Is a priority label assigned?
  • Is this ticket added to a milestone?
  • Is this ticket added to an epic? (Optional)
Completion Checklist

Is this ticket done? See
the Play Book Definition of Done

  • Has the acceptance criteria been met?
  • Is the documentation updated (including README)?
  • Do any code/documentation changes meet project standards?
  • Are automatic tests in place to verify the fix or new functionality?
    • Or are manual tests documented (at least on this ticket)?
  • Are any Playbook/Handbook pages updated?
  • Has a new module release (patch/minor) been created/scheduled?
  • Have the appropriate backport labels been added to the PR?
  • Is there a roll-out (and roll-back) plan if required?
Lingua principale
TypeScript
Stelle
0
Fork
2
Merge medio
16h 6m
PR unite (30g)
7

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di humanmade/altis-cli

Tutte le issue di humanmade/altis-cli

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.