Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,27 @@ opencli bilibili hot -f csv # CSV
opencli bilibili hot -v # Verbose: show pipeline debug
```

### Tab Completion

OpenCLI supports intelligent tab completion to speed up command input:

```bash
# Add shell completion to your startup config
echo 'eval "$(opencli completion zsh)"' >> ~/.zshrc # Zsh
echo 'eval "$(opencli completion bash)"' >> ~/.bashrc # Bash
echo 'opencli completion fish | source' >> ~/.config/fish/config.fish # Fish

# Restart your shell, then press Tab to complete:
opencli [Tab] # Complete site names (bilibili, zhihu, twitter...)
opencli bilibili [Tab] # Complete commands (hot, search, me, download...)
```

The completion includes:
- All available sites and adapters
- Built-in commands (list, explore, validate...)
- Command aliases
- Real-time updates as you add new adapters

## Next Steps

- [Installation details](/guide/installation)
Expand Down
21 changes: 21 additions & 0 deletions docs/zh/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,27 @@ opencli bilibili hot -f md # Markdown
opencli bilibili hot -f csv # CSV
```

## 终端自动补全

OpenCLI 支持智能的 Tab 自动补全,加快命令输入:

```bash
# 把自动补全加入 shell 启动配置
echo 'eval "$(opencli completion zsh)"' >> ~/.zshrc # Zsh
echo 'eval "$(opencli completion bash)"' >> ~/.bashrc # Bash
echo 'opencli completion fish | source' >> ~/.config/fish/config.fish # Fish

# 重启 shell 后,按 Tab 键补全:
opencli [Tab] # 补全站点名称(bilibili、zhihu、twitter...)
opencli bilibili [Tab] # 补全命令(hot、search、me、download...)
```

补全功能包含:
- 所有可用的站点和适配器
- 内置命令(list、explore、validate...)
- 命令别名
- 新增适配器时的实时更新

## 下一步

- [安装详情](/zh/guide/installation)
Expand Down