Gitlink
/
gitlink-cli
0
0
Fork 49
Code Issues Pull Requests 11 Packages Projects Releases 10 Wiki Activity

docs(readme): 补充 Shell 自动补全使用说明（中英双语） #425

Merged
wbtiger merged 6 commits from Taoyouce/gitlink-cli:docs/readme-completion into master 2026-07-14 20:34:26 +08:00
Conversation 0 Commits 6 Files Changed 2 +40
2 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -697,6 +697,26 @@ Get-Content issue.json | gitlink-cli api POST /Gitlink/forgeplus/issues --body-s
gitlink-cli api GET /Gitlink/forgeplus/commits --query 'page=1&limit=5'
```
### Shell Completion
`gitlink-cli` ships with built-in shell completion (bash / zsh / fish / PowerShell):
```bash
# Bash (add to ~/.bashrc)
source <(gitlink-cli completion bash)
# Zsh (add to ~/.zshrc)
source <(gitlink-cli completion zsh)
# Fish
gitlink-cli completion fish | source
# PowerShell
gitlink-cli completion powershell | Out-String | Invoke-Expression
```
Run `gitlink-cli completion <shell> --help` for install-once instructions per shell.
## Global Parameters
| Parameter | Description | Example |

20
README.zh-CN.md
View File

@ -571,6 +571,26 @@ Get-Content issue.json | gitlink-cli api POST /Gitlink/forgeplus/issues --body-s
gitlink-cli api GET /Gitlink/forgeplus/commits --query 'page=1&limit=5'
```
### Shell 自动补全
`gitlink-cli` 内置 bash / zsh / fish / PowerShell 补全：
```bash
# Bash（加入 ~/.bashrc）
source <(gitlink-cli completion bash)
# Zsh（加入 ~/.zshrc）
source <(gitlink-cli completion zsh)
# Fish
gitlink-cli completion fish | source
# PowerShell
gitlink-cli completion powershell | Out-String | Invoke-Expression
```
各 shell 的一次性安装方式见 `gitlink-cli completion <shell> --help`。
## 全局参数
| 参数 | 说明 | 示例 |