docs: add open, catch-up, timeline and history to the CLI reference
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 85/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- markdown, typescript
調査の方向性
まず packages/cli/src/help.ts のヘルプテキストの表を確認し、次に packages/cli/src/commands/open.ts、catch-up.ts、timeline.ts、history.ts の args 定義を読んでください。docs/packages/cli.mdx に、既存のコマンドセクションのレイアウトに従って、各コマンドのセクションを、そのオプションと例を一つ含めて追加してください。4つのコマンドそれぞれについて、文書化されたオプションが args および --help の出力と一致するセクションがあれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.mdxwith its options and at least one example. - Every option documented matches the command's
argsdefinition.
- 主要言語
- TypeScript
- スター
- 54.1k
- フォーク
- 4.9k
- 平均マージ
- 7時間 39分
- マージ済み PR（30日）
- 724
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
heygen-com/hyperframes のほかの issue
-
`hyperframes docs examples` lists templates that don't exist対応中かも @Muhtasim-Munif-Fahim が 1 日前に担当しました。 オープンbug difficulty/easy help wanted triage/ready
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
heygen-com/hyperframes#5393 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
lint: add tests for three caption rules that have none対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンdifficulty/easy enhancement help wanted triage/ready
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
heygen-com/hyperframes#5388 ·
メンテナーはふだん 1 日以内に返信
-
Move the keyframe property defaults table into @hyperframes/core対応中かも @meghna810 が 1 日前に担当しました。 オープンdifficulty/easy enhancement help wanted triage/ready
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
heygen-com/hyperframes#5387 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
gcp-cloud-run image pins Chrome 148, which drops `background-clip: text` glyphs inside layered children; the CLI's Chrome 152 paints them対応中かも @user-github-me が 3 日前に担当しました。 オープンbug difficulty/medium triage/ready
難易度 1/5 1時間未満 初心者へのやさしさ 84/100
heygen-com/hyperframes#5117 ·
メンテナーはふだん 1 日以内に返信
-
Docs: clarify that "Enable auto-update" is only available in the Claude Code terminal (CLI) /plugin UI対応中かも @rumi7911 が 5 日前に担当しました。 オープンdifficulty/easy documentation triage/ready
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
heygen-com/hyperframes#5027 ·
メンテナーはふだん 1 日以内に返信
heygen-com/hyperframes の issue をすべて見る
似ている issue
-
area:tui enhancement platform:macos
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
anthropics/claude-code#101490 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
netlify/netlify-mcp#75 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
atlassian-labs/compiled#1960 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
pnp/cli-microsoft365#7639 ·
メンテナーはふだん 2 日以内に返信
-
nextjs-tracking
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
cloudflare/vinext#3887 ·
メンテナーはふだん 1 日以内に返信