/ docs / zh / guide / getting-started.md
getting-started.md
 1  # 快速开始
 2  
 3  > **让任何网站或 Electron 应用成为你的 CLI。**
 4  > 零风险 · 复用 Chrome 登录态 · AI 驱动发现 · 浏览器 + 桌面自动化
 5  
 6  OpenCLI 将**任何网站**或 **Electron 应用**变成命令行界面 — Bilibili、知乎、小红书、Twitter/X、Reddit、YouTube、Antigravity 等 — 基于浏览器会话复用和 AI 原生发现。
 7  
 8  ## 安装
 9  
10  ```bash
11  npm install -g @jackwener/opencli
12  ```
13  
14  ## 基本使用
15  
16  ```bash
17  opencli list                              # 查看所有命令
18  opencli hackernews top --limit 5          # 公开 API,无需浏览器
19  opencli bilibili hot --limit 5            # 浏览器命令
20  opencli zhihu hot -f json                 # JSON 输出
21  ```
22  
23  ## 输出格式
24  
25  所有命令支持 `--format` / `-f`:
26  
27  ```bash
28  opencli bilibili hot -f table   # 默认:终端表格
29  opencli bilibili hot -f json    # JSON
30  opencli bilibili hot -f yaml    # YAML
31  opencli bilibili hot -f md      # Markdown
32  opencli bilibili hot -f csv     # CSV
33  ```
34  
35  ## 终端自动补全
36  
37  OpenCLI 支持智能的 Tab 自动补全,加快命令输入:
38  
39  ```bash
40  # 把自动补全加入 shell 启动配置
41  echo 'eval "$(opencli completion zsh)"' >> ~/.zshrc              # Zsh
42  echo 'eval "$(opencli completion bash)"' >> ~/.bashrc            # Bash
43  echo 'opencli completion fish | source' >> ~/.config/fish/config.fish  # Fish
44  
45  # 重启 shell 后,按 Tab 键补全:
46  opencli [Tab]          # 补全站点名称(bilibili、zhihu、twitter...)
47  opencli bilibili [Tab] # 补全命令(hot、search、me、download...)
48  ```
49  
50  补全功能包含:
51  - 所有可用的站点和适配器
52  - 内置命令(list、explore、validate...)
53  - 命令别名
54  - 新增适配器时的实时更新
55  
56  ## 下一步
57  
58  - [安装详情](/zh/guide/installation)
59  - [Browser Bridge 设置](/zh/guide/browser-bridge)
60  - [所有适配器](/zh/adapters/)
61  - [开发者指南](/zh/developer/contributing)
62  - [给新 Electron 应用生成 CLI](/zh/guide/electron-app-cli)