Skip to content

Formerly KrillinAI, VideoTranslation and Dubbing Tool for 120+ Languages. Open-source AI workspace for creators, powered by Codex. Video downloader, video translation, create videos, images, audios, and edits with Agents in one place. For your Social Media like YouTube, TikTok, Instagram, etc.

docs: add cli usage

wulien429de47be24d
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
index e0a8a953..9fdd410f 100644
--- a/.goreleaser.yaml
+++ b/.goreleaser.yaml
@@ -1,13 +1,24 @@
version: 2
builds:
- - env:
+ - id: server
+ binary: KrillinAI
+ env:
- CGO_ENABLED=0
goos:
- darwin
- linux
- windows
main: ./cmd/server/main.go
+ - id: cli
+ binary: krillinai
+ env:
+ - CGO_ENABLED=0
+ goos:
+ - darwin
+ - linux
+ - windows
+ main: ./cmd/cli/main.go
# Docker 构建配置
dockers:
diff --git a/README.md b/README.md
index 1e7af68d..a19a34f8 100644
--- a/README.md
+++ b/README.md
@@ -168,6 +168,19 @@ This software is not signed, so when running on macOS, after completing the file
This project supports Docker deployment; please refer to the [Docker Deployment Instructions](./docker.md)
+### CLI 用法
+
+KrillinAI 提供阶段化 CLI,适合脚本和 Agent 调用。每个命令默认同步执行,完成后输出 JSON。
+
+```bash
+krillinai subtitle "https://www.youtube.com/watch?v=dQw4w9WgXcQ" --origin-lang en --target-lang zh_cn --workdir tasks/demo
+krillinai tts --workdir tasks/demo --input-srt tasks/demo/target_language_srt.srt --line-mode target-only
+krillinai render-horizontal --workdir tasks/demo --video tasks/demo/origin_video.mp4 --subtitle tasks/demo/bilingual_srt.srt
+krillinai render-vertical --workdir tasks/demo --video tasks/demo/origin_video.mp4 --subtitle tasks/demo/short_origin_mixed_srt.srt
+```
+
+Agent 应优先读取 stdout JSON 和 `krillinai_manifest.json`,不要解析普通日志。
+
Based on the provided configuration file, here is the updated "Configuration Help (Must Read)" section for your README file:
### Configuration Help (Must Read)
@@ -223,4 +236,3 @@ Please visit [Frequently Asked Questions](./faq.md)
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=KrillinAI/KlicStudio&type=Date)](https://star-history.com/#KrillinAI/KlicStudio&Date)
-
diff --git a/docs/zh/README.md b/docs/zh/README.md
index 92b8cc30..8d302fd6 100644
--- a/docs/zh/README.md
+++ b/docs/zh/README.md
@@ -168,6 +168,19 @@ sudo chmod +x ./KlicStudio_1.0.0_desktop_macOS_arm64
该项目支持 Docker 部署;请参阅 [Docker 部署说明](./docker.md)
+### CLI 用法
+
+KrillinAI 提供阶段化 CLI,适合脚本和 Agent 调用。每个命令默认同步执行,完成后输出 JSON。
+
+```bash
+krillinai subtitle "https://www.youtube.com/watch?v=dQw4w9WgXcQ" --origin-lang en --target-lang zh_cn --workdir tasks/demo
+krillinai tts --workdir tasks/demo --input-srt tasks/demo/target_language_srt.srt --line-mode target-only
+krillinai render-horizontal --workdir tasks/demo --video tasks/demo/origin_video.mp4 --subtitle tasks/demo/bilingual_srt.srt
+krillinai render-vertical --workdir tasks/demo --video tasks/demo/origin_video.mp4 --subtitle tasks/demo/short_origin_mixed_srt.srt
+```
+
+Agent 应优先读取 stdout JSON 和 `krillinai_manifest.json`,不要解析普通日志。
+
根据提供的配置文件,以下是您 README 文件中更新的“配置帮助(必读)”部分:
### 配置帮助(必读)
@@ -222,4 +235,4 @@ sudo chmod +x ./KlicStudio_1.0.0_desktop_macOS_arm64
## Star 历史
-[![Star History Chart](https://api.star-history.com/svg?repos=KrillinAI/KlicStudio&type=Date)](https://star-history.com/#KrillinAI/KlicStudio&Date)
\ No newline at end of file
+[![Star History Chart](https://api.star-history.com/svg?repos=KrillinAI/KlicStudio&type=Date)](https://star-history.com/#KrillinAI/KlicStudio&Date)