Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open Beginner friendly
  • Is something wrong?
#5,386 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@meghna810 is already working on this.

Since Oct 10, 2026.

  • #5442 by @meghna810 — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
markdown, typescript
Domain
documentation

Research direction

Start with the help text table in packages/cli/src/help.ts, then read the args definitions in packages/cli/src/commands/open.ts, catch-up.ts, timeline.ts and history.ts. Add a section for each command to docs/packages/cli.mdx, following the layout of the existing command sections, with its options and one example. Done when each of the four commands has a section whose documented options match its args and --help output.

Written by the indexing model from the issue text.

Description

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.
Dominant language
TypeScript
Stars
54.1k
Forks
4.9k
Avg merge
7h 41m
Merged PRs (30d)
729

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from heygen-com/hyperframes

All issues in heygen-com/hyperframes

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.