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

docs: add open, catch-up, timeline and history to the CLI reference

Chiusa Adatta ai principianti
  • Qualcosa non va?
#5,386 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@meghna810 ci sta già lavorando.

Dal 10/10/2026.

  • #5442 di @meghna810 — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
85/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
markdown, typescript
Ambito
documentation

Direzione di ricerca

Inizia dalla tabella del testo di aiuto in packages/cli/src/help.ts, poi leggi le definizioni degli args in packages/cli/src/commands/open.ts, catch-up.ts, timeline.ts e history.ts. Aggiungi una sezione per ogni comando in docs/packages/cli.mdx, seguendo la struttura delle sezioni dei comandi esistenti, con le sue opzioni e un esempio. È completato quando ciascuno dei quattro comandi ha una sezione le cui opzioni documentate corrispondono ai suoi args e all'output di --help.

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

Descrizione

difficulty/easy documentation help wanted triage/ready

Problem

Four commands that hyperframes --help lists are missing from the CLI reference page, docs/packages/cli.mdx:

Command Help text (packages/cli/src/help.ts)
open Open a project in the HyperFrames desktop app
catch-up See what was done in the desktop app since you last looked
timeline Print the project's tracks and clips
history List, undo and restore the project's recorded changes

timeline gets a passing mention in docs/developers/cli.mdx; the others only appear in the changelog.

Proposed solution

Add a section for each to docs/packages/cli.mdx, matching the format of the existing command sections: what it does, its options, and an example. The options come from each command's args in packages/cli/src/commands/{open,catch-up,timeline,history}.ts; --help on each command shows the same.

Acceptance criteria

  • Each of the four commands has a section in docs/packages/cli.mdx with its options and at least one example.
  • Every option documented matches the command's args definition.
Lingua principale
TypeScript
Stelle
54.1k
Fork
4.9k
Merge medio
8h 39m
PR unite (30g)
736

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 heygen-com/hyperframes

Tutte le issue di heygen-com/hyperframes

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.