Skip to content

armgit / hypit

Public Imported from GitHub
0

Clone any viral video with AI agents. Not just a script, the whole workflow: swap the face, the words, the B-roll, ship 100 variants in one command, and get your 100M views.

docs(quickstart): reduce the Agent-user page to five steps with new videos

rpone54c685c85438
diff --git a/docs/quickstart.md b/docs/quickstart.md
index eabe42cf..c413db4f 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -1,171 +1,58 @@
---
title: Quickstart for Agent users
-description: Create, review and ship Hypit videos from a Coding Agent without writing SVML or SVS by hand.
+description: Clone a video from a Coding Agent in five steps.
---
-You do not need to know SVML, SVS, JavaScript or the command line. Describe your video in ordinary
-language; the Agent uses the `/hypit` skill to understand the reference, direct the work and deliver
-a video with an editable project.
+Describe the video you want in plain language. The Agent uses the `/hypit` skill to do the rest.
## What you need
- A Coding Agent that can use skills, such as Claude Code or Codex.
-- A reference video or a creative brief.
+- A reference video.
## 1. Install the Hypit skill
-Install the Hypit skill:
-
```bash
npx skills add hypit-ai/hypit -g
```
-Then start a Coding Agent anywhere; the Hypit skill is available globally. The Skill supplies
-production knowledge. The Agent checks whether the Hypit command is installed and sets up the
-executable tools when needed.
-
-## 2. Describe the video you want
-
-<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/describe_the_video_you_want.mp4"></video>
-
-You can take either of two paths.
-
-### Clone a reference video
-
-Ask the Agent to clone a video and provide its local file path:
-
-```text
-/hypit clone this video: /path/to/video.mp4
-```
-
-You can also provide a link from an online video platform. The Agent uses `yt-dlp` to download the
-source automatically. For example:
-
-```text
-/hypit clone this video: https://www.youtube.com/watch?v=VIDEO_ID
-/hypit clone this video: https://www.instagram.com/reel/REEL_ID/
-```
-
-Tell the Agent what should change, if anything: the host, language, product, aspect ratio, visual
-style or call to action. The reference is treated as evidence about the editorial structure. The
-Agent does not merely summarize it; it creates an editable program that can be reviewed and built.
-
-### Create an original video
-
-You can describe an idea just as you would brief a human producer. For example:
-
-```text
-Create a ranking video with a ranking board that has five rows. The left side labels the rows S, A, B,
-C and D, with a different color for each tier; the right side is for placing the icons assigned to
-each tier. Put Hypit in S tier and explain its advantages. Also include Arcads, Higgsfield, Seedance
-and CapCut. Give each competitor a fair, concise summary of its strengths and weaknesses. Make the
-result clear, energetic and suitable for a short social video.
-```
-
-You can add constraints such as audience, duration, language, tone, brand colors, presenter, platform
-or aspect ratio. The Agent turns the brief into a complete plan and fills in production details from
-the information you provide.
+Start a Coding Agent anywhere. The Agent installs the Hypit tools on first use.
-## 3. Provide credentials when the Agent asks
+## 2. Clone a video and swap in your product
-<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/provide_credentials_when_the_agent_asks.mp4"></video>
+<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/clone_a_video_with_your_product.mp4"></video>
-After you describe the video, the Agent checks which models and services the project needs. If a
-required credential is missing, it will ask you for it and explain what it is used for. You have two
-options:
-
-1. **Use Hypit's recommended Hypit.ai OAuth login.** Tell the Agent to log in through hypit.ai. This
- single OAuth flow covers all models that Hypit provides through its hosted service, so you do not
- need to collect separate keys for each model.
-2. **Use your own provider keys.** You can tell the Agent which models to use and provide API keys
- from the corresponding providers. The Agent will request only the keys needed for this project
- and will not ask for unrelated credentials.
-
-Never paste a secret into a public document or commit it to Git. The Agent stores credentials using
-the configured secure credential store.
-
-## 4. Let the Agent do the production work
-
-<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/let_the_agent_do_the_production_work.mp4"></video>
-
-The Agent understands the reference in terms of your goal. Timed frames and words help it explain
-the story, pacing, and the purpose and timing of captions, B-roll and graphics. A replacement person
-or product shapes the script and creative direction from the beginning.
-
-It records those decisions in project files, selects or writes suitable components, generates media,
-and composes the video around its semantic timeline. Studio and selected-range renders help check
-layout, timing and readability. The Agent reuses existing media and keeps you informed about material
-decisions, progress and problems.
-
-## 5. Review the composition in Studio
-
-<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/review_the_mock_studio.mp4"></video>
-
-Studio displays the media, captions and graphics selected by the current Run. The Agent can inspect
-composition with existing material and continue refining it as generated media becomes available.
-
-Check whether the story is clear, captions are readable, the product or ranking board has enough
-prominence, and B-roll appears where it helps. Describe the change you want:
+Give the Agent a file or a link, and say what changes:
```text
-The board appears too late and the captions are too small. Bring the board in with the words
-introducing the ranking, and make the captions larger.
+/hypit Clone this video: /path/to/video.mp4, and replace the product with Hypit (hypit.ai).
```
-The Agent changes the relevant parts and shows the updated composition.
+YouTube, Instagram and other platform links work; the Agent downloads the source. Change the host,
+product, language, aspect ratio or call to action in the same sentence.
-## 6. Approve and submit the paid Build
+## 3. Log in to Hypit, or bring your own keys
-<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/approve_and_submit_the_paid_build.mp4"></video>
+<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/log_in_to_hypit_or_bring_your_own_key.mp4"></video>
-Before new paid work, the Agent explains the selected models, expected external work and available
-pricing information. Authorize a concrete production scope:
+When a model needs a credential, the Agent asks. One hypit.ai login covers every model Hypit hosts;
+or give the Agent API keys for the providers you prefer. Credentials go into the system credential
+store.
-```text
-Generate the media and finish the video with this direction, within the budget we agreed.
-```
-
-The Agent submits a Build and follows its outcome. Completed media and outputs remain in the
-project's Result. If an attempt fails, the Agent explains the failure and reuses available outputs
-through a new Run and Build.
-
-## 7. Review the finished video
-
-<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/review_the_paid_result.mp4"></video>
+## 4. Check the quote, then approve
-When the Build finishes, the Agent provides the final video and its saved location. Review the
-content, captions, transitions, framing and sound against your goal. Describe any changes you want;
-the project retains editable Sources and generated media.
+<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/check_the_quote_and_approve.mp4"></video>
-## 8. Request natural-language changes
-
-<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/request_natural_language_changes.mp4"></video>
-
-After a successful Build, you can continue directing the project conversationally. You may change
-the host, replace B-roll, alter the ranking-board treatment, translate the script, adjust the tone or
-switch the aspect ratio. For example:
+Before spending anything, the Agent lists every paid request with its price. Approve, and it submits
+the Build:
```text
-Keep the script and ranking order, but replace the host with a calm male presenter and make the board
-look like a paper sports magazine.
+Go.
```
-The Agent traces each request to the relevant source and component, preserves what you asked it to
-keep, and reuses existing outputs. New paid generation follows your authorized scope.
-
-## 9. Create multiple variants in parallel
-
-<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/create_multiple_variants_in_parallel.mp4"></video>
-
-When you want several versions, first tell the Agent the dimensions that may vary. It will discuss
-the intended directions with you, for example:
+## 5. Watch the finished video
-- one version with a different host;
-- one version translated into Spanish;
-- one version with a product-focused opening;
-- one version with faster cuts and denser B-roll.
+<video controls playsInline preload="metadata" width="100%" src="./quickstart/videos/watch_the_finished_video.mp4"></video>
-The Agent records the shared parts and each version's changes, then gives every variant explicit
-production choices. Independent work can execute concurrently within the Runtime's configured
-capacity; shared media can be reused. You receive each finished video, its project files and a clear
-account of completion.
+The Agent delivers the video and shows it to you in Studio. If you want changes, keep talking to the
+Agent.
diff --git a/docs/zh/quickstart.md b/docs/zh/quickstart.md
index 8d680511..b61060da 100644
--- a/docs/zh/quickstart.md
+++ b/docs/zh/quickstart.md
@@ -1,132 +1,55 @@
---
title: 面向 Agent 使用者的快速开始
-description: 无需手写 SVML 或 SVS,通过 Coding Agent 创建、审阅并交付 Hypit 视频。
+description: 通过 Coding Agent 复刻一条视频,共五步。
---
-你不需要了解 SVML、SVS、JavaScript 或命令行。用日常语言向 Coding Agent 描述视频,Agent 会通过 `/hypit` skill 理解参考、设计内容、制作视频,并交付可继续修改的项目。
+用日常语言描述你要的视频,其余交给 Agent 和 `/hypit` skill。
## 你需要准备什么
- 一个能够使用 skill 的 Coding Agent,例如 Claude Code 或 Codex;
-- 一条用于复刻的视频,或一份用于原创视频的创意简报。
+- 一条参考视频。
## 1. 安装 Hypit skill
-先安装 Hypit skill:
-
```bash
npx skills add hypit-ai/hypit -g
```
-然后在任意处启动 Coding Agent,Hypit skill 将全局可用。Skill 提供制作知识;Agent 会检查 Hypit 命令是否可用,并在需要时安装可执行工具。
+在任意位置启动 Coding Agent。首次使用时,Agent 会自行安装 Hypit 工具。
### **👉 [免费获得 100 个拥有独特音色的 AI 人物形象](https://drive.google.com/drive/u/2/folders/18J9Fz7mkU3OQNJ-2Res3eIyFQ2cemIK5)**
-## 2. 描述你想制作的视频
-
-<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/describe_the_video_you_want.mp4"></video>
-
-你可以选择以下两种方式之一。
-
-### 复刻一条参考视频
-
-要求 Agent 复刻视频,并提供本地视频文件路径:
-
-```text
-/hypit 克隆这条视频:/path/to/video.mp4
-```
-
-你也可以直接提供在线视频平台的链接。Agent 会使用 `yt-dlp` 自动下载视频。例如:
-
-```text
-/hypit 克隆这条视频:https://www.youtube.com/watch?v=VIDEO_ID
-/hypit 克隆这条视频:https://www.instagram.com/reel/REEL_ID/
-```
-
-如果需要改变内容,也可以一并说明,例如更换主持人、语言、产品、画幅比例、视觉风格或行动号召。参考视频会被当作剪辑结构的证据;Agent 不会只给你一份分析报告,而是会创建一套可以审阅、修改和 Build 的完整视频程序。
-
-### 原创一条视频
-
-你可以像给一位真人制片人写 brief 一样描述想法。例如:
-
-```text
-请制作一条 ranking 视频。视频中有一个 ranking 板子,包含五行:左侧是 S、A、B、C、D 五个等级,每个等级使用不同的颜色;右侧用于摆放对应等级的图标。把 Hypit 排到 S 级,并解释它的优势;同时加入 Arcads、Higgsfield、Seedance 和 CapCut,对每个竞品给出公平而简洁的优点与缺点说明。整体要清晰、有活力,适合短视频平台。
-```
-
-你还可以补充目标受众、时长、语言、语气、品牌色、主持人、发布平台或画幅比例等要求。Agent 会把 brief 转换成完整计划,并自行补全制作所需的细节。
-
-## 3. 按 Agent 提示提供凭据
+## 2. 复刻一条视频,换成你的产品
-<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/provide_credentials_when_the_agent_asks.mp4"></video>
+<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/clone_a_video_with_your_product.mp4"></video>
-在你描述视频之后,Agent 会检查项目需要哪些模型和服务。如果缺少必要凭据,Agent 会向你询问,并说明该凭据的用途。你可以选择两种方式:
-
-1. **使用 Hypit 推荐的 hypit.ai OAuth 登录。** 告诉 Agent 通过 hypit.ai 登录。一次 OAuth 登录即可覆盖 Hypit 托管服务提供的所有模型,不需要为每个模型分别收集 key。
-2. **使用你自己的 Provider key。** 你可以直接和 Agent 约定要使用哪些模型,并提供相应 Provider 的 API key。Agent 只会索取当前项目需要的 key,不会询问无关凭据。
-
-不要把密钥粘贴到公开文档中,也不要提交到 Git。Agent 会使用已配置的安全凭据存储来保存这些凭据。
-
-## 4. 让 Agent 完成制作
-
-<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/let_the_agent_do_the_production_work.mp4"></video>
-
-Agent 会从你的目的出发理解参考视频,结合带时间的帧图和台词,弄清故事、节奏,以及字幕、B-roll、图形的作用与出现时机。换人或换产品的要求会从一开始影响剧本和设计。
-
-它把这些决定写入项目文件,选择或编写合适的组件,用图片与视频模型制作素材,再按语义时间线编排。Studio 和局部渲染帮助检查版面、时机与可读性。已有素材会被复用;重要的决定、进展和问题会及时告诉你。
-
-## 5. 在 Studio 查看编排
-
-<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/review_the_mock_studio.mp4"></video>
-
-Studio 展示当前 Run 选定的素材、字幕和图形。Agent 可以用已有素材检查构图,也可以在生成素材后继续调整编排。
-
-查看故事是否清楚、字幕是否易读、产品或 ranking 板是否突出、B-roll 是否放在合适的位置。直接描述你想要的改变:
+给 Agent 一个文件或链接,并说明要改什么:
```text
-ranking 板出现得太晚,字幕太小。让板子跟着介绍排名的台词出现,并把字幕放大一些。
+/hypit 克隆这条视频:/path/to/video.mp4,把产品换成 Hypit(hypit.ai)。
```
-Agent 会修改对应部分,再展示更新后的画面。
+YouTube、Instagram 等平台链接都可以,Agent 会自动下载。主持人、产品、语言、画幅、行动号召,都可以在同一句话里说明。
-## 6. 确认后提交付费 Build
+## 3. 登录 Hypit,或使用自己的 key
-<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/approve_and_submit_the_paid_build.mp4"></video>
+<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/log_in_to_hypit_or_bring_your_own_key.mp4"></video>
-开始新的付费工作前,Agent 会说明所选模型、将要执行的外部工作和可查到的价格信息。你可以授权明确的制作范围:
+模型需要凭据时,Agent 会向你索要。登录一次 hypit.ai 即可使用 Hypit 托管的全部模型;也可以把你偏好的 Provider 的 API key 交给 Agent。凭据保存在系统凭据存储中。
-```text
-按这个方案生成素材并完成视频,预算在我们刚确认的范围内。
-```
-
-Agent 提交 Build 并跟进结果。已完成的素材和输出会保存在项目的 Result 中;出现失败时,它会说明原因,并在新的 Run 和 Build 中复用可用产物。
-
-## 7. 查看成片
-
-<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/review_the_paid_result.mp4"></video>
+## 4. 查看报价,批准生成
-Build 完成后,Agent 会提供最终视频及保存位置。查看内容、字幕、转场、构图和声音是否符合你的目标。需要修改时,直接告诉 Agent;项目保留可编辑的源码和已生成素材。
+<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/check_the_quote_and_approve.mp4"></video>
-## 8. 继续用自然语言提出修改
-
-<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/request_natural_language_changes.mp4"></video>
-
-Build 成功后,你仍然可以用对话继续指导项目。你可以更换主持人、替换 B-roll、改变 ranking 板的样式、翻译台词、调整语气或切换画幅比例。例如:
+花钱之前,Agent 会列出每一项付费请求及其价格。批准后,它提交 Build:
```text
-保留台词和排名顺序,但把主持人换成沉稳的男主持,并把 ranking 板做成纸质体育杂志风格。
+开始。
```
-Agent 会把每项要求落实到对应的源码和组件,保留你要求不变的部分,并复用已有产物。新的付费生成遵循你授权的范围。
-
-## 9. 并行制作多个变体
-
-<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/create_multiple_variants_in_parallel.mp4"></video>
-
-如果需要多个版本,先告诉 Agent 哪些维度可以变化。它会与你讨论具体方向,例如:
+## 5. 查看成片
-- 更换主持人的版本;
-- 翻译成西班牙语的版本;
-- 把产品卖点放到开头的版本;
-- 加快剪辑、增加 B-roll 密度的版本。
+<video controls playsInline preload="metadata" width="100%" src="../quickstart/videos/watch_the_finished_video.mp4"></video>
-Agent 会整理各版本共用的内容和各自的变化,为每个版本写出明确的制作选择。独立工作可以并发执行,具体并发量由运行配置控制;共用素材可显式复用。最终你会得到每个版本的成片、项目文件和完成情况。
+Agent 交付视频,并在 Studio 中展示给你。如果还有修改意见,继续与 Agent 沟通即可。