ext/hyperframes
2
0
Fork 0
mirror of https://github.com/heygen-com/hyperframes.git synced 2026-09-03 04:38:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: address PR review — fix skill paths, Copilot CLI commands, MCP flag

Browse Source 
- Fix project skill directory to .agents/skills/ (plural) in both guides,
  matching vercel-labs/skills agent registry
- Replace invented --mcp-server flag with correct --additional-mcp-config
  flag and JSON/file syntax for Copilot CLI
- Remove non-existent /skills reload, /skills list, /skills info commands;
  document only /skills (picker) and /skills add
- Remove non-existent github-copilot binary alias
- Antigravity MCP section now defers to Antigravity's own MCP docs for
  the exact settings UI path
- Rename CLAUDE.md section to "Agent instruction files", document both
  AGENTS.md (cross-agent) and CLAUDE.md
- Use --agent long form instead of -a in examples
- Add link to Antigravity Manager view docs
- Add token budget caveat for large skill sets in Copilot CLI
This commit is contained in:
Miguel Ángel
2026-05-19 13:02:43 -04:00
parent 9342d3dea8
commit 00cbdd1d6e
2 changed files with 31 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/guides/antigravity.mdx
+15 -12
View File
@@ -13,13 +13,13 @@ Install the HyperFrames skill package into your project:
npx skills add heygen-com/hyperframes npx skills add heygen-com/hyperframes
``` ```
This places skill directories inside `.agent/skills/` at your workspace root — the location Antigravity scans for workspace-scoped skills. This places skill directories inside `.agents/skills/` at your workspace root — the location Antigravity scans for workspace-scoped skills.
<Tip> <Tip>
If you want the skills available across all your Antigravity projects, copy them to the global scope instead: If you want the skills available across all your Antigravity projects, install them to the global scope instead:
```bash ```bash
npx skills add heygen-com/hyperframes -a antigravity --global npx skills add heygen-com/hyperframes --agent antigravity --global
``` ```
Global skills live in `~/.gemini/antigravity/skills/` and load in every workspace. Global skills live in `~/.gemini/antigravity/skills/` and load in every workspace.
@@ -28,7 +28,7 @@ This places skill directories inside `.agent/skills/` at your workspace root —
Verify the skills are installed: Verify the skills are installed:
```bash ```bash
ls .agent/skills/ ls .agents/skills/
``` ```
You should see directories like `hyperframes/`, `hyperframes-cli/`, `gsap/`, `tailwind/`, and others — each containing a `SKILL.md` that the agent reads on demand. You should see directories like `hyperframes/`, `hyperframes-cli/`, `gsap/`, `tailwind/`, and others — each containing a `SKILL.md` that the agent reads on demand.
@@ -100,7 +100,7 @@ The skill is only injected into the agent's context window when it matches — t
## Using multiple agents in Manager view ## Using multiple agents in Manager view
Antigravity's Manager view lets you orchestrate multiple agents in parallel. For complex multi-scene videos, you can split the work: Antigravity's [Manager view](https://antigravity.google/docs/agent) lets you orchestrate multiple agents in parallel. For complex multi-scene videos, you can split the work:
- **Agent 1:** Author the intro scene and transitions - **Agent 1:** Author the intro scene and transitions
- **Agent 2:** Generate TTS narration and caption timing - **Agent 2:** Generate TTS narration and caption timing
@@ -110,17 +110,20 @@ Each agent picks up the relevant HyperFrames skills independently. Merge the out
## MCP alternative ## MCP alternative
If you prefer zero-install cloud authoring, Antigravity supports MCP servers. Add the HyperFrames MCP connector to author and render compositions without the CLI: If you prefer zero-install cloud authoring, Antigravity supports remote MCP servers. Add the HyperFrames MCP connector to author and render compositions without the CLI — see [Antigravity's MCP documentation](https://antigravity.google/docs/mcp) for the exact setup steps in your version, then use the server URL:
1. Open **Settings → MCP Servers → Add Server** ```
2. Enter: `https://mcp.heygen.com/mcp/hyperframes` https://mcp.heygen.com/mcp/hyperframes
3. Authorize via OAuth with your HeyGen account ```
See the [MCP guide](/guides/mcp) for full details. The MCP handles rendering in the cloud; the CLI gives you local control. Authorize via OAuth with your HeyGen account when prompted. See the [HyperFrames MCP guide](/guides/mcp) for full details on tools and prompting. The MCP handles rendering in the cloud; the CLI gives you local control.
## CLAUDE.md compatibility ## Agent instruction files
When Antigravity's agent uses a Claude model (Sonnet or Opus), it reads your project's `CLAUDE.md` for project-specific instructions. HyperFrames projects created with `npx hyperframes init` include a `CLAUDE.md` automatically, giving the agent additional composition context beyond what the skills provide. HyperFrames projects created with `npx hyperframes init` scaffold both `CLAUDE.md` and `AGENTS.md` automatically — these give the agent additional composition context beyond what the skills provide.
- **`AGENTS.md`** — the cross-agent convention. Antigravity reads this regardless of which model you've selected (Gemini, Claude, or others).
- **`CLAUDE.md`** — read when Antigravity's agent uses a Claude model (Sonnet or Opus), providing Claude-specific project instructions.
## Tips ## Tips
docs/guides/copilot-cli.mdx
+16 -30
View File
@@ -19,31 +19,19 @@ Install the HyperFrames skill package into your project:
npx skills add heygen-com/hyperframes npx skills add heygen-com/hyperframes
``` ```
This writes skill directories to `.github/skills/` in your project — one of the paths Copilot CLI scans automatically. This writes skill directories to `.agents/skills/` in your project — the path Copilot CLI scans automatically for workspace-scoped skills.
<Tip> <Tip>
To make skills available across all your projects, install them globally: To make skills available across all your projects, install them globally:
```bash ```bash
npx skills add heygen-com/hyperframes -a github-copilot --global npx skills add heygen-com/hyperframes --agent github-copilot --global
``` ```
Global skills live in `~/.copilot/skills/` and load in every Copilot CLI session. Global skills live in `~/.copilot/skills/` and load in every Copilot CLI session.
</Tip> </Tip>
If you install skills during an active session, reload them: If you install skills during an active session, run `/skills` to open the skills picker and verify they appear. New skills installed to the project directory are picked up automatically on the next prompt.
```
/skills reload
```
Verify they're available:
```
/skills list
```
You should see `hyperframes`, `hyperframes-cli`, `gsap`, `tailwind`, and others in the list.
## Using skills ## Using skills
@@ -73,16 +61,14 @@ Copilot also matches skills based on the `description` field in each `SKILL.md`.
Create a 9:16 TikTok hook video about AI productivity with bouncy captions. Create a 9:16 TikTok hook video about AI productivity with bouncy captions.
``` ```
Explicit invocation is more reliable when you have many skills installed. Explicit invocation is more reliable when you have many skills installed — with large skill sets, the agent's token budget may not fit every skill description, so naming the skill directly guarantees it loads.
### Skill management commands ### Skill management
| Command | What it does | | Command | What it does |
|---|---| |---|---|
| `/skills list` | Show all available skills | | `/skills` | Open the interactive skills picker — browse, enable, or disable skills |
| `/skills info hyperframes` | View skill details and file location | | `/skills add <path>` | Add an additional skill directory to the current session |
| `/skills reload` | Reload after installing new skills mid-session |
| `/skills` | Enable or disable skills interactively |
## Create and preview a video ## Create and preview a video
@@ -110,12 +96,6 @@ Explicit invocation is more reliable when you have many skills installed.
```bash ```bash
copilot copilot
``` ```
Or if using the npm global install:
```bash
github-copilot
```
</Step> </Step>
<Step title="Prompt with the skill"> <Step title="Prompt with the skill">
@@ -170,10 +150,16 @@ In agent mode, Copilot runs terminal commands (like `npx hyperframes init` and `
## MCP alternative ## MCP alternative
Copilot CLI also supports MCP servers for cloud-based authoring without the local CLI: Copilot CLI also supports MCP servers for cloud-based authoring without the local CLI. Use the `--additional-mcp-config` flag to add the HyperFrames MCP server to your session:
```bash ```bash
copilot --mcp-server https://mcp.heygen.com/mcp/hyperframes copilot --additional-mcp-config '{"mcpServers":{"hyperframes":{"url":"https://mcp.heygen.com/mcp/hyperframes"}}}'
```
Or save the config to a file and reference it:
```bash
copilot --additional-mcp-config @mcp-config.json
``` ```
Authorize via OAuth when prompted. See the [MCP guide](/guides/mcp) for full details. Authorize via OAuth when prompted. See the [MCP guide](/guides/mcp) for full details.
@@ -181,7 +167,7 @@ Authorize via OAuth when prompted. See the [MCP guide](/guides/mcp) for full det
## Tips ## Tips
- **Always start with `/hyperframes` for composition work.** This loads the full skill context — composition rules, data attributes, GSAP patterns, caption formats — that generic web knowledge doesn't cover. - **Always start with `/hyperframes` for composition work.** This loads the full skill context — composition rules, data attributes, GSAP patterns, caption formats — that generic web knowledge doesn't cover.
- **Use `/skills info hyperframes` to check skill status.** If output looks wrong, the skill might not be loaded. Reload with `/skills reload`. - **Use `/skills` to check skill status.** If output looks wrong, open the skills picker to verify the HyperFrames skills are enabled.
- **Run `npx hyperframes lint` before rendering.** The linter catches structural issues the agent might miss on complex multi-scene edits. - **Run `npx hyperframes lint` before rendering.** The linter catches structural issues the agent might miss on complex multi-scene edits.
- **Keep the preview server running in a separate terminal.** You see every edit reflected in real time while prompting in Copilot CLI. - **Keep the preview server running in a separate terminal.** You see every edit reflected in real time while prompting in Copilot CLI.
- **Install registry blocks for transitions and effects.** `npx hyperframes add shimmer-sweep` installs pre-built blocks, then prompt the agent to wire them in. - **Install registry blocks for transitions and effects.** `npx hyperframes add shimmer-sweep` installs pre-built blocks, then prompt the agent to wire them in.