📝 Update docs with install prompt, MCP and skills setup
This commit is contained in:
OpenWaygate committed
1 parent
c9b7e3a85c
commit
61d8a8ce6c
5 files changed
+147
-56
No files matched your search
@@ -3,7 +3,6 @@
|
||||
# `yutu`
|
||||
|
||||
[](https://gitmoji.dev)
|
||||
[](https://goreportcard.com/report/github.com/eat-pray-ai/yutu)
|
||||
[](https://github.com/eat-pray-ai/yutu?tab=Apache-2.0-1-ov-file)
|
||||
[](https://pkg.go.dev/github.com/eat-pray-ai/yutu)
|
||||
[](https://raw.githack.com/wiki/eat-pray-ai/yutu/coverage.html)
|
||||
@@ -21,8 +20,8 @@
|
||||
)](https://winstall.app/apps/eat-pray-ai.yutu)
|
||||
[](https://www.npmjs.com/package/@eat-pray-ai/yutu)
|
||||
|
||||
[](https://www.producthunt.com/products/yutu?embed=true&utm_source=badge-featured&utm_medium=badge&utm_campaign=badge-youtube-cli-mcp-server-skill-and-agent)
|
||||
<!-- [](https://www.producthunt.com/products/yutu?embed=true&utm_source=badge-featured&utm_medium=badge&utm_campaign=badge-youtube-cli-mcp-server-skill-and-agent) -->
|
||||
|
||||
`yutu` is a CLI, MCP server, and AI agent for YouTube that automates your entire YouTube workflow — from uploading and optimizing videos to managing comments, playlists, and channel branding — so you can get more views, higher click-through rates, and stronger audience engagement with less manual effort. [中文文档](./README_zh.md)
|
||||
|
||||
@@ -51,6 +50,7 @@ An account on [Google Cloud Platform](https://console.cloud.google.com/) is requ
|
||||
- Go to `APIs & Services -> OAuth consent screen`, create a consent screen with yourself as a test user
|
||||
- Go to `Credentials -> Create Credentials -> OAuth Client ID`, select `Desktop app`
|
||||
- Download the credential file and save it as `client_secret.json`, it should look like
|
||||
|
||||
```json
|
||||
{
|
||||
"installed": {
|
||||
@@ -66,12 +66,15 @@ An account on [Google Cloud Platform](https://console.cloud.google.com/) is requ
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. **Authenticate**:
|
||||
|
||||
```bash
|
||||
yutu auth --credential client_secret.json
|
||||
```
|
||||
|
||||
A browser window will open for you to grant YouTube access. After granting permission, a token is saved to `youtube.token.json`.
|
||||
|
||||
```json
|
||||
{
|
||||
"access_token": "ya29.XXXXXXXXX",
|
||||
@@ -95,6 +98,12 @@ By default, `yutu` will read `client_secret.json` and `youtube.token.json` from
|
||||
|
||||
## Installation
|
||||
|
||||
If you're using an AI agent, copy and paste the following prompt to finish the installation:
|
||||
|
||||
```plaintext
|
||||
Install and configure yutu by following https://raw.githubusercontent.com/eat-pray-ai/yutu/refs/heads/main/internal/tools/skillgen/setup.md
|
||||
```
|
||||
|
||||
You can download `yutu` from [releases page](https://github.com/eat-pray-ai/yutu/releases/latest) directly, or use the following methods as you prefer.
|
||||
|
||||
<details>
|
||||
@@ -224,7 +233,7 @@ the `provider:modelName` format (only `google` is supported). If only one is set
|
||||
|
||||
Then run the following command for detail usage:
|
||||
|
||||
```
|
||||
```shell
|
||||
❯ yutu agent --help
|
||||
❯ yutu agent --args "help"
|
||||
# console mode
|
||||
@@ -313,7 +322,7 @@ See [skills/youtube/SKILL.md](skills/youtube/SKILL.md) for the full list of supp
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
❯ yutu
|
||||
❯ yutu
|
||||
yutu is a CLI, MCP server, and AI agent for YouTube that can automate almost all YouTube workflows.
|
||||
|
||||
Environment variables:
|
||||
@@ -327,6 +336,7 @@ Usage:
|
||||
yutu [command]
|
||||
|
||||
Available Commands:
|
||||
abuseReport Manage YouTube abuse reports
|
||||
activity Manage activities on YouTube
|
||||
agent Start an agent to automate YouTube workflows
|
||||
auth Authenticate with YouTube APIs
|
||||
@@ -340,6 +350,11 @@ Available Commands:
|
||||
help Help about any command
|
||||
i18nLanguage Manage YouTube i18n languages
|
||||
i18nRegion Manage YouTube i18n regions
|
||||
liveBroadcast Manage YouTube live broadcasts
|
||||
liveChatBan Manage YouTube live chat bans
|
||||
liveChatMessage Manage YouTube live chat messages
|
||||
liveChatModerator Manage YouTube live chat moderators
|
||||
liveStream Manage YouTube live streams
|
||||
mcp Start MCP server
|
||||
member Manage YouTube channel members
|
||||
membershipsLevel Manage YouTube memberships levels
|
||||
@@ -370,7 +385,3 @@ Please refer to [FEATURES.md](docs/FEATURES.md) for more information.
|
||||
## Contributing
|
||||
|
||||
Please refer to [CONTRIBUTING.md](docs/CONTRIBUTING.md) for more information.
|
||||
|
||||
## Star History
|
||||
|
||||
[](https://star-history.com/#eat-pray-ai/yutu&Date)
|
||||
+16
-9
@@ -3,7 +3,6 @@
|
||||
# `yutu`
|
||||
|
||||
[](https://gitmoji.dev)
|
||||
[](https://goreportcard.com/report/github.com/eat-pray-ai/yutu)
|
||||
[](https://github.com/eat-pray-ai/yutu?tab=Apache-2.0-1-ov-file)
|
||||
[](https://pkg.go.dev/github.com/eat-pray-ai/yutu)
|
||||
[](https://raw.githack.com/wiki/eat-pray-ai/yutu/coverage.html)
|
||||
@@ -21,8 +20,8 @@
|
||||
)](https://winstall.app/apps/eat-pray-ai.yutu)
|
||||
[](https://www.npmjs.com/package/@eat-pray-ai/yutu)
|
||||
|
||||
[](https://www.producthunt.com/products/yutu?embed=true&utm_source=badge-featured&utm_medium=badge&utm_campaign=badge-youtube-cli-mcp-server-skill-and-agent)
|
||||
<!-- [](https://www.producthunt.com/products/yutu?embed=true&utm_source=badge-featured&utm_medium=badge&utm_campaign=badge-youtube-cli-mcp-server-skill-and-agent) -->
|
||||
|
||||
`yutu` 是一个 YouTube CLI、MCP 服务器和 AI Agent，可以自动化您的整个 YouTube 工作流程——从上传和优化视频到管理评论、播放列表和频道品牌——帮助您获得更多播放量、更高的点击率和更强的观众互动，同时大幅减少手动操作。
|
||||
|
||||
@@ -105,6 +104,12 @@ Hunt](https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=11
|
||||
|
||||
## 安装
|
||||
|
||||
如果您正在使用 AI Agent，可以复制以下提示词来完成安装：
|
||||
|
||||
```plaintext
|
||||
Install and configure yutu by following https://raw.githubusercontent.com/eat-pray-ai/yutu/refs/heads/main/internal/tools/skillgen/setup.md
|
||||
```
|
||||
|
||||
您可以直接从[发布页面](https://github.com/eat-pray-ai/yutu/releases/latest)下载 `yutu`，或使用以下您喜欢的方法。
|
||||
|
||||
<details>
|
||||
@@ -233,7 +238,7 @@ yutu 有两个可用的 GitHub Action，一个是通用 action，另一个专用
|
||||
|
||||
然后运行以下命令查看详细用法：
|
||||
|
||||
```
|
||||
```shell
|
||||
❯ yutu agent --help
|
||||
❯ yutu agent --args "help"
|
||||
# console mode
|
||||
@@ -322,7 +327,7 @@ yutu 有两个可用的 GitHub Action，一个是通用 action，另一个专用
|
||||
## 使用方法
|
||||
|
||||
```shell
|
||||
❯ yutu
|
||||
❯ yutu
|
||||
yutu is a CLI, MCP server, and AI agent for YouTube that can automate almost all YouTube workflows.
|
||||
|
||||
Environment variables:
|
||||
@@ -336,6 +341,7 @@ Usage:
|
||||
yutu [command]
|
||||
|
||||
Available Commands:
|
||||
abuseReport Manage YouTube abuse reports
|
||||
activity Manage activities on YouTube
|
||||
agent Start an agent to automate YouTube workflows
|
||||
auth Authenticate with YouTube APIs
|
||||
@@ -349,6 +355,11 @@ Available Commands:
|
||||
help Help about any command
|
||||
i18nLanguage Manage YouTube i18n languages
|
||||
i18nRegion Manage YouTube i18n regions
|
||||
liveBroadcast Manage YouTube live broadcasts
|
||||
liveChatBan Manage YouTube live chat bans
|
||||
liveChatMessage Manage YouTube live chat messages
|
||||
liveChatModerator Manage YouTube live chat moderators
|
||||
liveStream Manage YouTube live streams
|
||||
mcp Start MCP server
|
||||
member Manage YouTube channel members
|
||||
membershipsLevel Manage YouTube memberships levels
|
||||
@@ -379,7 +390,3 @@ Use "yutu [command] --help" for more information about a command.
|
||||
## 贡献
|
||||
|
||||
请参考 [CONTRIBUTING.md](docs/CONTRIBUTING.md) 获取更多信息。
|
||||
|
||||
## Star 历史
|
||||
|
||||
[](https://star-history.com/#eat-pray-ai/yutu&Date)
|
||||
+29
-24
@@ -89,7 +89,7 @@ Here are the features that are currently supported by yutu 🟢, and the ones th
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="5">comments</td>
|
||||
<td rowspan="6">comments</td>
|
||||
<td>🟢 list</td>
|
||||
<td>1</td>
|
||||
<td>tool</td>
|
||||
@@ -104,6 +104,11 @@ Here are the features that are currently supported by yutu 🟢, and the ones th
|
||||
<td>50</td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟢 markAsSpam</td>
|
||||
<td>50</td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟢 setModerationStatus</td>
|
||||
<td>50</td>
|
||||
@@ -145,39 +150,39 @@ Here are the features that are currently supported by yutu 🟢, and the ones th
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="7">liveBroadcasts</td>
|
||||
<td>🟡 list</td>
|
||||
<td>🟢 list</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟡 insert</td>
|
||||
<td>🟢 insert</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟡 insertCuepoint</td>
|
||||
<td>🟢 insertCuepoint</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟡 update</td>
|
||||
<td>🟢 update</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟡 bind</td>
|
||||
<td>🟢 bind</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟡 transition</td>
|
||||
<td>🟢 transition</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟡 delete</td>
|
||||
<td>🟢 delete</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="2">liveChatBans</td>
|
||||
@@ -192,24 +197,24 @@ Here are the features that are currently supported by yutu 🟢, and the ones th
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="4">liveChatMessages</td>
|
||||
<td>🟡 list</td>
|
||||
<td>🟢 list</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟡 insert</td>
|
||||
<td>🟢 insert</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟡 delete</td>
|
||||
<td>🟢 delete</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟡 transition</td>
|
||||
<td>🟢 transition</td>
|
||||
<td>?</td>
|
||||
<td></td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td rowspan="3">liveChatModerators</td>
|
||||
@@ -314,7 +319,7 @@ Here are the features that are currently supported by yutu 🟢, and the ones th
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>🟢 upload</td>
|
||||
<td>🟢 update</td>
|
||||
<td>?</td>
|
||||
<td>tool</td>
|
||||
</tr>
|
||||
|
||||
@@ -30,7 +30,6 @@ An account on [Google Cloud Platform](https://console.cloud.google.com/) is requ
|
||||
|
||||
Install `yutu` using one of these methods:
|
||||
|
||||
|
||||
```bash
|
||||
# Node.js (all platforms)
|
||||
npm i -g @eat-pray-ai/yutu
|
||||
@@ -38,20 +37,55 @@ npm i -g @eat-pray-ai/yutu
|
||||
# macOS
|
||||
brew install yutu
|
||||
|
||||
# Linux
|
||||
brew install yutu
|
||||
# Linux / macOS (shell script)
|
||||
curl -sSfL https://raw.githubusercontent.com/eat-pray-ai/yutu/main/scripts/install.sh | bash
|
||||
|
||||
# Windows
|
||||
winget install yutu
|
||||
|
||||
# Gopher
|
||||
go install github.com/eat-pray-ai/yutu@latest
|
||||
```
|
||||
|
||||
### Other platforms
|
||||
|
||||
Download a prebuilt binary from the [releases page](https://github.com/eat-pray-ai/yutu/releases/latest) and place it in your PATH.
|
||||
|
||||
## MCP Server
|
||||
|
||||
Add `yutu` as an MCP server after installation and authentication:
|
||||
|
||||
```bash
|
||||
# Claude Code
|
||||
claude mcp add -e YUTU_CREDENTIAL=/absolute/path/to/client_secret.json \
|
||||
-e YUTU_CACHE_TOKEN=/absolute/path/to/youtube.token.json \
|
||||
yutu -- yutu mcp
|
||||
|
||||
# Codex
|
||||
codex mcp add --env YUTU_CREDENTIAL=/absolute/path/to/client_secret.json \
|
||||
--env YUTU_CACHE_TOKEN=/absolute/path/to/youtube.token.json \
|
||||
yutu -- yutu mcp
|
||||
```
|
||||
|
||||
For VS Code, Cursor, or other tools, add to your MCP settings:
|
||||
|
||||
```json
|
||||
{
|
||||
"yutu": {
|
||||
"type": "stdio",
|
||||
"command": "yutu",
|
||||
"args": ["mcp"],
|
||||
"env": {
|
||||
"YUTU_CREDENTIAL": "/absolute/path/to/client_secret.json",
|
||||
"YUTU_CACHE_TOKEN": "/absolute/path/to/youtube.token.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Skills
|
||||
|
||||
```bash
|
||||
npx skills add https://github.com/eat-pray-ai/yutu/tree/main/skills/youtube
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable | Description | Default |
|
||||
@@ -61,4 +95,4 @@ Download a prebuilt binary from the [releases page](https://github.com/eat-pray-
|
||||
| `YUTU_ROOT` | Root directory for file resolution | Current working directory |
|
||||
| `YUTU_LOG_LEVEL` | Log level: `DEBUG`, `INFO`, `WARN`, `ERROR` | `INFO` |
|
||||
|
||||
For more details, see the [yutu README](https://github.com/eat-pray-ai/yutu#readme).
|
||||
For more details, see the [README](https://github.com/eat-pray-ai/yutu#readme).
|
||||
@@ -30,7 +30,6 @@ An account on [Google Cloud Platform](https://console.cloud.google.com/) is requ
|
||||
|
||||
Install `yutu` using one of these methods:
|
||||
|
||||
|
||||
```bash
|
||||
# Node.js (all platforms)
|
||||
npm i -g @eat-pray-ai/yutu
|
||||
@@ -38,20 +37,55 @@ npm i -g @eat-pray-ai/yutu
|
||||
# macOS
|
||||
brew install yutu
|
||||
|
||||
# Linux
|
||||
brew install yutu
|
||||
# Linux / macOS (shell script)
|
||||
curl -sSfL https://raw.githubusercontent.com/eat-pray-ai/yutu/main/scripts/install.sh | bash
|
||||
|
||||
# Windows
|
||||
winget install yutu
|
||||
|
||||
# Gopher
|
||||
go install github.com/eat-pray-ai/yutu@latest
|
||||
```
|
||||
|
||||
### Other platforms
|
||||
|
||||
Download a prebuilt binary from the [releases page](https://github.com/eat-pray-ai/yutu/releases/latest) and place it in your PATH.
|
||||
|
||||
## MCP Server
|
||||
|
||||
Add `yutu` as an MCP server after installation and authentication:
|
||||
|
||||
```bash
|
||||
# Claude Code
|
||||
claude mcp add -e YUTU_CREDENTIAL=/absolute/path/to/client_secret.json \
|
||||
-e YUTU_CACHE_TOKEN=/absolute/path/to/youtube.token.json \
|
||||
yutu -- yutu mcp
|
||||
|
||||
# Codex
|
||||
codex mcp add --env YUTU_CREDENTIAL=/absolute/path/to/client_secret.json \
|
||||
--env YUTU_CACHE_TOKEN=/absolute/path/to/youtube.token.json \
|
||||
yutu -- yutu mcp
|
||||
```
|
||||
|
||||
For VS Code, Cursor, or other tools, add to your MCP settings:
|
||||
|
||||
```json
|
||||
{
|
||||
"yutu": {
|
||||
"type": "stdio",
|
||||
"command": "yutu",
|
||||
"args": ["mcp"],
|
||||
"env": {
|
||||
"YUTU_CREDENTIAL": "/absolute/path/to/client_secret.json",
|
||||
"YUTU_CACHE_TOKEN": "/absolute/path/to/youtube.token.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Skills
|
||||
|
||||
```bash
|
||||
npx skills add https://github.com/eat-pray-ai/yutu/tree/main/skills/youtube
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable | Description | Default |
|
||||
@@ -61,4 +95,4 @@ Download a prebuilt binary from the [releases page](https://github.com/eat-pray-
|
||||
| `YUTU_ROOT` | Root directory for file resolution | Current working directory |
|
||||
| `YUTU_LOG_LEVEL` | Log level: `DEBUG`, `INFO`, `WARN`, `ERROR` | `INFO` |
|
||||
|
||||
For more details, see the [yutu README](https://github.com/eat-pray-ai/yutu#readme).
|
||||
For more details, see the [README](https://github.com/eat-pray-ai/yutu#readme).
|
||||
Reference in new issue
Block a user