bibi

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

BibiGPT CLI (
bibi
)

BibiGPT CLI(
bibi

Summarize videos, audio, and podcasts from the terminal using the BibiGPT API.
通过BibiGPT API在终端中总结视频、音频和播客内容。

Installation

安装

macOS (Homebrew)

macOS(Homebrew)

bash
brew install --cask jimmylv/bibigpt/bibigpt
bash
brew install --cask jimmylv/bibigpt/bibigpt

Windows

Windows

Download the installer from: https://bibigpt.co/download/desktop
winget install BibiGPT
is pending review and not yet available.
从以下链接下载安装程序:https://bibigpt.co/download/desktop
winget install BibiGPT
正在审核中,暂不可用。

Verify installation

验证安装

bash
bibi --version
bash
bibi --version

Authentication

认证

After installing, the user must log in via the desktop app at least once. The CLI reads the saved session automatically from the desktop app's settings.
Alternatively, set an API token:
bash
export BIBI_API_TOKEN=<token>
On Windows (PowerShell):
powershell
$env:BIBI_API_TOKEN="<token>"
安装完成后,用户至少需要通过桌面应用登录一次。CLI会自动从桌面应用的设置中读取已保存的会话。
或者,设置API令牌:
bash
export BIBI_API_TOKEN=<token>
在Windows(PowerShell)中:
powershell
$env:BIBI_API_TOKEN="<token>"

Commands

命令

Summarize a URL

总结URL

Important: URLs containing
?
or
&
must be quoted to avoid shell glob errors.
bash
undefined
重要提示:包含
?
&
的URL必须加引号,以避免shell通配符错误。
bash
undefined

Basic summary (Markdown output to stdout)

基础总结(Markdown格式输出到标准输出)

bibi summarize "<URL>"
bibi summarize "<URL>"

Async mode — recommended for long videos (>30min)

异步模式 — 推荐用于长视频(超过30分钟)

bibi summarize "<URL>" --async
bibi summarize "<URL>" --async

Chapter-by-chapter summary

逐章节总结

bibi summarize "<URL>" --chapter
bibi summarize "<URL>" --chapter

Fetch subtitles/transcript only (no AI summary)

仅获取字幕/转录文本(无AI总结)

bibi summarize "<URL>" --subtitle
bibi summarize "<URL>" --subtitle

Full JSON response

完整JSON响应

bibi summarize "<URL>" --json
bibi summarize "<URL>" --json

Combine flags

组合参数

bibi summarize "<URL>" --subtitle --json

**Supported URL types**: YouTube, Bilibili, podcasts, audio files, and any URL supported by BibiGPT.
bibi summarize "<URL>" --subtitle --json

**支持的URL类型**:YouTube、B站、播客、音频文件,以及所有BibiGPT支持的URL。

Authentication

认证相关命令

bash
undefined
bash
undefined

Check current auth status

检查当前认证状态

bibi auth check
bibi auth check

Open browser to log in

打开浏览器登录

bibi auth login
bibi auth login

Show how to set API token

查看API令牌设置方法

bibi auth set-token <TOKEN>
undefined
bibi auth set-token <TOKEN>
undefined

Updates

更新

bash
undefined
bash
undefined

Check if a new version is available

检查是否有新版本可用

bibi check-update
bibi check-update

Download and install the latest version

下载并安装最新版本

bibi self-update
undefined
bibi self-update
undefined

Output Format

输出格式

  • Default: Markdown summary text sent to stdout. Progress info goes to stderr.
  • --json: Complete API response as pretty-printed JSON to stdout.
This means you can pipe the output:
bash
bibi summarize "<URL>" > summary.md
bibi summarize "<URL>" --json | jq '.summary'
  • 默认:Markdown格式的总结文本输出到标准输出(stdout),进度信息输出到标准错误(stderr)。
  • --json:完整的API响应以格式化的JSON输出到标准输出(stdout)。
这意味着你可以通过管道处理输出:
bash
bibi summarize "<URL>" > summary.md
bibi summarize "<URL>" --json | jq '.summary'

Error Handling

错误处理

Exit CodeMeaning
0Success
1Error (auth missing, API error, timeout, etc.)
HTTP StatusUser Action
401Token expired — run
bibi auth login
or re-login in desktop app
402/403Quota exceeded — visit https://bibigpt.co/pricing
429Rate limited — wait and retry
退出码含义
0成功
1错误(缺少认证、API错误、超时等)
HTTP状态码用户操作
401令牌过期 — 运行
bibi auth login
或重新在桌面应用中登录
402/403配额用尽 — 访问https://bibigpt.co/pricing
429请求受限 — 等待后重试

Usage Tips

使用技巧

  • For very long videos, use
    --async
    to avoid HTTP timeout.
  • Use
    --subtitle
    to get raw subtitles/transcript without AI summarization.
  • Use
    --json
    when you need structured data (e.g.,
    sourceUrl
    ,
    htmlUrl
    ,
    detail
    ).
  • The
    --chapter
    flag provides section-by-section summaries, useful for lectures or tutorials.
  • The CLI does NOT open any GUI window — all output goes to the terminal.
  • Run
    bibi check-update
    periodically to get new features and bug fixes.
  • 对于超长视频,使用
    --async
    参数避免HTTP超时。
  • 使用
    --subtitle
    参数获取原始字幕/转录文本,无需AI总结。
  • 当你需要结构化数据(如
    sourceUrl
    htmlUrl
    detail
    )时,使用
    --json
    参数。
  • --chapter
    参数提供逐章节的总结,适合讲座或教程内容。
  • CLI不会打开任何GUI窗口 — 所有输出都在终端中显示。
  • 定期运行
    bibi check-update
    以获取新功能和修复bug。