Skip to content

Commit c4ec40a

Browse files
committed
docs: update README for v0.1.17 — branch skill, npm one-step install, 12 skills
1 parent d5e15c6 commit c4ec40a

1 file changed

Lines changed: 45 additions & 24 deletions

File tree

README.md

Lines changed: 45 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55
[![Go Version](https://img.shields.io/badge/Go-1.26%2B-blue.svg)](https://golang.org)
66
[![npm version](https://img.shields.io/npm/v/@gitlink-ai/cli.svg)](https://www.npmjs.com/package/@gitlink-ai/cli)
77

8-
The official [GitLink](https://www.gitlink.org.cn) CLI tool — built for humans and AI Agents. Supports **macOS, Linux, and Windows**. Covers repository management, issue tracking, pull requests, CI/CD, and AI-powered workflows, with 40+ commands and 11 AI Agent [Skills](./skills/).
8+
The official [GitLink](https://www.gitlink.org.cn) CLI tool — built for humans and AI Agents. Supports **macOS, Linux, and Windows**. Covers repository management, issue tracking, pull requests, CI/CD, and AI-powered workflows, with 40+ commands and 12 AI Agent [Skills](./skills/).
99

1010
**[中文文档](./README.zh-CN.md)**
1111

1212
[Install](#installation--quick-start) · [AI Agent Skills](#ai-agent-skills) · [Auth](#configure--use) · [Commands](#usage-examples) · [Contributing](#related-projects)
1313

1414
## Why gitlink-cli?
1515

16-
- **Agent-Native Design**11 structured [Skills](./skills/) out of the box, compatible with Claude Code — Agents can operate GitLink with zero extra setup
16+
- **Agent-Native Design**12 structured [Skills](./skills/) out of the box, compatible with Claude Code, OpenClaw, and other AI platforms — Agents can operate GitLink with zero extra setup
1717
- **Wide Coverage** — Repository, Issue, PR, Branch, Release, CI, Org, Search, User — all core domains covered
1818
- **AI-Friendly & Optimized** — Every command is tested with real Agents, featuring concise parameters, smart defaults, and structured output
19-
- **Cross-Platform** — Runs on macOS, Linux, and Windows (x64/arm64), install via `npm` in one command
19+
- **Cross-Platform** — Runs on macOS, Linux, and Windows (x64/arm64), install via `npm install -g @gitlink-ai/cli` in one command, binary auto-downloaded
2020
- **Open Source, Zero Barriers** — MulanPSL-2.0 license, ready to use, just `npm install`
2121
- **Up and Running in 3 Minutes** — Interactive login or `GITLINK_TOKEN` env var, from install to first API call in just 3 steps
2222
- **Secure & Controllable** — OS-native keychain credential storage, `GITLINK_TOKEN` env var for CI/CD & non-interactive environments, auto git remote context resolution
@@ -29,7 +29,7 @@ The official [GitLink](https://www.gitlink.org.cn) CLI tool — built for humans
2929
| 📦 Repo | List, create, fork, delete repositories, view repo info |
3030
| 🐛 Issue | Create, update, close, batch close, comment on issues |
3131
| 🔀 PR | Create, merge, review pull requests, view changed files |
32-
| 🌿 Branch | Create, delete, protect branches |
32+
| 🌿 Branch | Create, delete, list, protect, unprotect branches |
3333
| 🏷️ Release | Create, view, delete releases |
3434
| 🏢 Org | Manage organizations, members, teams |
3535
| 🔧 CI | View builds, logs, CI/CD operations |
@@ -52,32 +52,23 @@ The official [GitLink](https://www.gitlink.org.cn) CLI tool — built for humans
5252
5353
#### Install
5454

55-
Choose **one** of the following methods:
56-
57-
**Option 1 — From npm (recommended):**
55+
**From npm (recommended):**
5856

5957
```bash
60-
# Install CLI
58+
# One command: installs CLI binary + all 12 AI Agent Skills
6159
npm install -g @gitlink-ai/cli
62-
63-
# Install CLI Skills (required, works on all platforms)
64-
gitlink-cli-install-skills
65-
66-
# Or install Skills with npx
67-
npx skills add ccfos/gitlink-cli/skills -y -g
6860
```
6961

70-
**Option 2 — From source:**
62+
The binary is auto-downloaded for your platform during `postinstall`. No extra steps needed.
63+
64+
**From source:**
7165

7266
Requires Go 1.26+.
7367

7468
```bash
7569
git clone https://www.gitlink.org.cn/Gitlink/gitlink-cli.git
7670
cd gitlink-cli
7771
make install
78-
79-
# Install CLI Skills (required)
80-
npx skills add ./skills -y -g
8172
```
8273

8374
> **Windows users:** Run `npm install -g @gitlink-ai/cli` in PowerShell or CMD. For building from source, use `go install .` instead of `make install`.
@@ -104,11 +95,8 @@ gitlink-cli repo +list
10495
**Step 1 — Install**
10596

10697
```bash
107-
# Install CLI
98+
# One command: CLI binary + all Skills auto-installed
10899
npm install -g @gitlink-ai/cli
109-
110-
# Install CLI Skills (required, works on all platforms)
111-
gitlink-cli-install-skills
112100
```
113101

114102
**Step 2 — Configure**
@@ -202,6 +190,25 @@ gitlink-cli pr +merge --owner Gitlink --repo forgeplus -i 42
202190
gitlink-cli pr +files --owner Gitlink --repo forgeplus -i 42
203191
```
204192

193+
### Branch Management
194+
195+
```bash
196+
# List branches
197+
gitlink-cli branch +list --owner Gitlink --repo forgeplus
198+
199+
# Create a branch
200+
gitlink-cli branch +create --name feature/new-feature
201+
202+
# Delete a branch
203+
gitlink-cli branch +delete --name feature/old-feature
204+
205+
# Protect a branch
206+
gitlink-cli branch +protect --name main
207+
208+
# Remove branch protection
209+
gitlink-cli branch +unprotect --name main
210+
```
211+
205212
### Release Management
206213

207214
```bash
@@ -215,6 +222,19 @@ gitlink-cli release +create --owner Gitlink --repo forgeplus -t v1.0.0 -n "v1.0.
215222
gitlink-cli release +view --owner Gitlink --repo forgeplus -i <version_id>
216223
```
217224

225+
### CI/CD Operations
226+
227+
```bash
228+
# List builds
229+
gitlink-cli ci +list --owner Gitlink --repo forgeplus
230+
231+
# View build log
232+
gitlink-cli ci +log --owner Gitlink --repo forgeplus -i <build_id>
233+
234+
# Restart a build
235+
gitlink-cli ci +restart --owner Gitlink --repo forgeplus -i <build_id>
236+
```
237+
218238
### Search
219239

220240
```bash
@@ -273,7 +293,7 @@ git push gitlink
273293

274294
## AI Agent Skills
275295

276-
The `skills/` directory contains 11 Claude Code Agent Skill files for AI-automated GitLink operations.
296+
The `skills/` directory contains 12 Agent Skill files for AI-automated GitLink operations.
277297

278298
See [skills/README.md](skills/README.md) for details.
279299

@@ -283,10 +303,11 @@ See [skills/README.md](skills/README.md) for details.
283303
| `gitlink-repo` | Repository operations (create, view, delete, fork, etc.) |
284304
| `gitlink-issue` | Issue operations (create, update, close, comment, etc.) |
285305
| `gitlink-pr` | Pull request operations (create, merge, review, etc.) |
306+
| `gitlink-branch` | Branch management (create, delete, list, protect, unprotect) |
286307
| `gitlink-release` | Release management (create, view, delete, etc.) |
287-
| `gitlink-org` | Organization management (members, teams, etc.) |
288308
| `gitlink-ci` | CI/CD operations (builds, logs, etc.) |
289309
| `gitlink-search` | Search (repositories, users, etc.) |
310+
| `gitlink-org` | Organization management (members, teams, etc.) |
290311
| `gitlink-user` | User management (profile info, etc.) |
291312
| `gitlink-pm` | Project management (sprints, kanban, weekly reports, etc.) |
292313
| `gitlink-workflow` | AI-powered workflows (issue triage, PR review, release notes, etc.) |

0 commit comments

Comments
 (0)