Skip to content

Commit e1811b2

Browse files
GloriaGuoGloriaGuo
committed
Add banner and one-click install scripts
1 parent b08171e commit e1811b2

8 files changed

Lines changed: 280 additions & 17 deletions

File tree

‎README.md‎

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
English | [中文](./README.zh-CN.md)
44

5+
![OpenCLI Skill Banner](./assets/banner.svg)
6+
57
An agent skill for working with [OpenCLI](https://github.com/jackwener/opencli): command discovery, browser-login reuse, desktop-app adapters, downloads, troubleshooting, and adapter-generation workflows.
68

79
Repository: [GloriaGuo/opencli-skill](https://github.com/GloriaGuo/opencli-skill)
@@ -48,16 +50,61 @@ This skill gives AI coding agents a read-first, agent-safe operating path so the
4850
- [examples/openclaw.md](./examples/openclaw.md): OpenClaw installation and usage examples
4951
- [examples/openclaw-prompts.md](./examples/openclaw-prompts.md): OpenClaw-ready prompt templates for multi-channel agents
5052
- [examples/openclaw.json5.example](./examples/openclaw.json5.example): fuller OpenClaw skill-loading config example
53+
- [assets/banner.svg](./assets/banner.svg): repository banner and ready-to-upload social preview asset
54+
- [install.sh](./install.sh): one-click install script for Unix-like shells
55+
- [install.ps1](./install.ps1): one-click install script for PowerShell
5156
- [scripts/validate_skill.py](./scripts/validate_skill.py): portable validation script for CI and local checks
5257

5358
## Install
5459

60+
### One-Click Install
61+
62+
Unix-like shells:
63+
64+
```bash
65+
./install.sh codex
66+
./install.sh claude
67+
./install.sh openclaw
68+
./install.sh openclaw-workspace
69+
```
70+
71+
Remote install without cloning first:
72+
73+
```bash
74+
curl -fsSL https://raw.githubusercontent.com/GloriaGuo/opencli-skill/main/install.sh | bash -s -- codex
75+
curl -fsSL https://raw.githubusercontent.com/GloriaGuo/opencli-skill/main/install.sh | bash -s -- claude
76+
curl -fsSL https://raw.githubusercontent.com/GloriaGuo/opencli-skill/main/install.sh | bash -s -- openclaw
77+
```
78+
79+
PowerShell:
80+
81+
```powershell
82+
./install.ps1 codex
83+
./install.ps1 claude
84+
./install.ps1 openclaw
85+
./install.ps1 openclaw-workspace
86+
```
87+
88+
Remote install without cloning first:
89+
90+
```powershell
91+
irm https://raw.githubusercontent.com/GloriaGuo/opencli-skill/main/install.ps1 | iex
92+
```
93+
94+
### Repository Banner / Social Preview
95+
96+
The repository includes a ready-made banner asset at [assets/banner.svg](./assets/banner.svg).
97+
98+
- it is already embedded at the top of this README
99+
- it can also be uploaded manually in GitHub repository settings as a social preview image
100+
- if you want a PNG version later, export the SVG at 1280×640 or 2560×1280
101+
55102
### Codex
56103

57104
Clone or copy the repo into your Codex skills directory:
58105

59106
```bash
60-
git clone git@github.com:GloriaGuo/opencli-skill.git "${CODEX_HOME:-$HOME/.codex}/skills/opencli"
107+
git clone https://github.com/GloriaGuo/opencli-skill.git "${CODEX_HOME:-$HOME/.codex}/skills/opencli"
61108
```
62109

63110
Or copy the folder contents manually into:
@@ -81,15 +128,15 @@ Use $opencli to troubleshoot why my Zhihu command returns empty data.
81128
Codex-oriented installation path:
82129

83130
```bash
84-
git clone git@github.com:GloriaGuo/opencli-skill.git "${CODEX_HOME:-$HOME/.codex}/skills/opencli"
131+
git clone https://github.com/GloriaGuo/opencli-skill.git "${CODEX_HOME:-$HOME/.codex}/skills/opencli"
85132
```
86133

87134
## Use In Claude Code
88135

89136
Claude Code skills typically live under `~/.claude/skills`. Copy or clone this repository there:
90137

91138
```bash
92-
git clone git@github.com:GloriaGuo/opencli-skill.git ~/.claude/skills/opencli
139+
git clone https://github.com/GloriaGuo/opencli-skill.git ~/.claude/skills/opencli
93140
```
94141

95142
Then ask Claude Code in natural language or reference the skill explicitly:
@@ -111,13 +158,13 @@ OpenClaw can load shared skills from `~/.openclaw/skills` or workspace-specific
111158
Shared install for all agents:
112159

113160
```bash
114-
git clone git@github.com:GloriaGuo/opencli-skill.git ~/.openclaw/skills/opencli
161+
git clone https://github.com/GloriaGuo/opencli-skill.git ~/.openclaw/skills/opencli
115162
```
116163

117164
Workspace-specific install:
118165

119166
```bash
120-
git clone git@github.com:GloriaGuo/opencli-skill.git ./skills/opencli
167+
git clone https://github.com/GloriaGuo/opencli-skill.git ./skills/opencli
121168
```
122169

123170
Config file: `~/.openclaw/openclaw.json`
@@ -275,7 +322,7 @@ python3 scripts/validate_skill.py
275322
### Codex
276323

277324
```bash
278-
git clone git@github.com:GloriaGuo/opencli-skill.git "${CODEX_HOME:-$HOME/.codex}/skills/opencli"
325+
git clone https://github.com/GloriaGuo/opencli-skill.git "${CODEX_HOME:-$HOME/.codex}/skills/opencli"
279326
```
280327

281328
或者手动复制到：
@@ -299,15 +346,15 @@ Use $opencli to troubleshoot why my Zhihu command returns empty data.
299346
Codex 默认安装路径：
300347

301348
```bash
302-
git clone git@github.com:GloriaGuo/opencli-skill.git "${CODEX_HOME:-$HOME/.codex}/skills/opencli"
349+
git clone https://github.com/GloriaGuo/opencli-skill.git "${CODEX_HOME:-$HOME/.codex}/skills/opencli"
303350
```
304351

305352
## 在 Claude Code 里怎么用
306353

307354
Claude Code 的 skill 通常放在 `~/.claude/skills` 下，可以这样安装：
308355

309356
```bash
310-
git clone git@github.com:GloriaGuo/opencli-skill.git ~/.claude/skills/opencli
357+
git clone https://github.com/GloriaGuo/opencli-skill.git ~/.claude/skills/opencli
311358
```
312359

313360
然后直接用自然语言，或者显式提到 `$opencli`：
@@ -329,13 +376,13 @@ OpenClaw 可以从 `~/.openclaw/skills` 读取共享 skill，也可以从当前
329376
给所有 agent 共用的安装方式：
330377

331378
```bash
332-
git clone git@github.com:GloriaGuo/opencli-skill.git ~/.openclaw/skills/opencli
379+
git clone https://github.com/GloriaGuo/opencli-skill.git ~/.openclaw/skills/opencli
333380
```
334381

335382
只给当前 workspace 使用：
336383

337384
```bash
338-
git clone git@github.com:GloriaGuo/opencli-skill.git ./skills/opencli
385+
git clone https://github.com/GloriaGuo/opencli-skill.git ./skills/opencli
339386
```
340387

341388
配置文件位置：`~/.openclaw/openclaw.json`

‎README.zh-CN.md‎

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
[English](./README.md) | 中文
44

5+
![OpenCLI Skill Banner](./assets/banner.svg)
6+
57
一个面向多种 AI agent 环境的 OpenCLI skill，帮助 agent 用更稳定、可发现、只读优先的方式调用 OpenCLI。
68

79
仓库地址：[GloriaGuo/opencli-skill](https://github.com/GloriaGuo/opencli-skill)
@@ -49,33 +51,78 @@ OpenCLI 本身覆盖了很多能力：
4951
- [examples/openclaw.md](./examples/openclaw.md)：OpenClaw 用法
5052
- [examples/openclaw-prompts.md](./examples/openclaw-prompts.md)：OpenClaw prompt 模板
5153
- [examples/openclaw.json5.example](./examples/openclaw.json5.example)：OpenClaw 配置示例
54+
- [assets/banner.svg](./assets/banner.svg)：仓库 banner 和可上传的社交预览图素材
55+
- [install.sh](./install.sh)：Unix-like 环境一键安装脚本
56+
- [install.ps1](./install.ps1)：PowerShell 一键安装脚本
5257

5358
## 安装
5459

60+
### 一键安装
61+
62+
Unix-like shell：
63+
64+
```bash
65+
./install.sh codex
66+
./install.sh claude
67+
./install.sh openclaw
68+
./install.sh openclaw-workspace
69+
```
70+
71+
如果不想先 clone，也可以直接远程执行：
72+
73+
```bash
74+
curl -fsSL https://raw.githubusercontent.com/GloriaGuo/opencli-skill/main/install.sh | bash -s -- codex
75+
curl -fsSL https://raw.githubusercontent.com/GloriaGuo/opencli-skill/main/install.sh | bash -s -- claude
76+
curl -fsSL https://raw.githubusercontent.com/GloriaGuo/opencli-skill/main/install.sh | bash -s -- openclaw
77+
```
78+
79+
PowerShell：
80+
81+
```powershell
82+
./install.ps1 codex
83+
./install.ps1 claude
84+
./install.ps1 openclaw
85+
./install.ps1 openclaw-workspace
86+
```
87+
88+
如果不想先 clone，也可以直接远程执行：
89+
90+
```powershell
91+
irm https://raw.githubusercontent.com/GloriaGuo/opencli-skill/main/install.ps1 | iex
92+
```
93+
94+
### 仓库 Banner / 社交预览图
95+
96+
仓库已经自带一个可直接使用的素材：[assets/banner.svg](./assets/banner.svg)。
97+
98+
- 它已经显示在 README 顶部
99+
- 你也可以手动上传到 GitHub 仓库设置中的 social preview image
100+
- 如果你后面想要 PNG，可以把这个 SVG 导出为 1280×640 或 2560×1280
101+
55102
### Codex
56103

57104
```bash
58-
git clone git@github.com:GloriaGuo/opencli-skill.git "${CODEX_HOME:-$HOME/.codex}/skills/opencli"
105+
git clone https://github.com/GloriaGuo/opencli-skill.git "${CODEX_HOME:-$HOME/.codex}/skills/opencli"
59106
```
60107

61108
### Claude Code
62109

63110
```bash
64-
git clone git@github.com:GloriaGuo/opencli-skill.git ~/.claude/skills/opencli
111+
git clone https://github.com/GloriaGuo/opencli-skill.git ~/.claude/skills/opencli
65112
```
66113

67114
### OpenClaw
68115

69116
共享安装：
70117

71118
```bash
72-
git clone git@github.com:GloriaGuo/opencli-skill.git ~/.openclaw/skills/opencli
119+
git clone https://github.com/GloriaGuo/opencli-skill.git ~/.openclaw/skills/opencli
73120
```
74121

75122
workspace 安装：
76123

77124
```bash
78-
git clone git@github.com:GloriaGuo/opencli-skill.git ./skills/opencli
125+
git clone https://github.com/GloriaGuo/opencli-skill.git ./skills/opencli
79126
```
80127

81128
## 推荐的 OpenCLI 环境准备

‎assets/banner.svg‎

Lines changed: 66 additions & 0 deletions
Loading

‎examples/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ This folder contains practical prompts and command recipes you can copy into Cod
88
- [openclaw.md](./openclaw.md): OpenClaw installation and invocation examples
99
- [openclaw-prompts.md](./openclaw-prompts.md): multi-channel OpenClaw prompt templates
1010
- [openclaw.json5.example](./openclaw.json5.example): fuller OpenClaw config example
11+
- [../install.sh](../install.sh): one-click installer for Unix-like shells
12+
- [../install.ps1](../install.ps1): one-click installer for PowerShell

‎examples/claude-code.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This document shows how to install and use the OpenCLI skill in Claude Code.
77
Clone this repository into Claude Code's skills directory:
88

99
```bash
10-
git clone git@github.com:GloriaGuo/opencli-skill.git ~/.claude/skills/opencli
10+
git clone https://github.com/GloriaGuo/opencli-skill.git ~/.claude/skills/opencli
1111
```
1212

1313
If the folder already exists, update it:

‎examples/openclaw.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ OpenClaw supports multiple skill locations:
1212
Shared install:
1313

1414
```bash
15-
git clone git@github.com:GloriaGuo/opencli-skill.git ~/.openclaw/skills/opencli
15+
git clone https://github.com/GloriaGuo/opencli-skill.git ~/.openclaw/skills/opencli
1616
```
1717

1818
Workspace install:
1919

2020
```bash
21-
git clone git@github.com:GloriaGuo/opencli-skill.git ./skills/opencli
21+
git clone https://github.com/GloriaGuo/opencli-skill.git ./skills/opencli
2222
```
2323

2424
## Config File

‎install.ps1‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
param(
2+
[ValidateSet("codex", "claude", "openclaw", "openclaw-workspace")]
3+
[string]$Target = "codex",
4+
[string]$RepoUrl = "https://github.com/GloriaGuo/opencli-skill.git"
5+
)
6+
7+
$ErrorActionPreference = "Stop"
8+
9+
switch ($Target) {
10+
"codex" {
11+
$targetDir = Join-Path ($(if ($env:CODEX_HOME) { $env:CODEX_HOME } else { Join-Path $HOME ".codex" })) "skills/opencli"
12+
}
13+
"claude" {
14+
$targetDir = Join-Path $HOME ".claude/skills/opencli"
15+
}
16+
"openclaw" {
17+
$targetDir = Join-Path $HOME ".openclaw/skills/opencli"
18+
}
19+
"openclaw-workspace" {
20+
$targetDir = Join-Path (Get-Location) "skills/opencli"
21+
}
22+
}
23+
24+
$parentDir = Split-Path $targetDir -Parent
25+
New-Item -ItemType Directory -Force -Path $parentDir | Out-Null
26+
27+
if (Test-Path (Join-Path $targetDir ".git")) {
28+
Write-Host "Updating existing install at $targetDir"
29+
git -C $targetDir pull --ff-only
30+
} else {
31+
Write-Host "Cloning $RepoUrl to $targetDir"
32+
git clone $RepoUrl $targetDir
33+
}
34+
35+
Write-Host ""
36+
Write-Host "Installed OpenCLI skill to:"
37+
Write-Host " $targetDir"
38+
Write-Host ""
39+
Write-Host "Next steps:"
40+
Write-Host " 1. Ensure OpenCLI is installed: npm install -g @jackwener/opencli"
41+
Write-Host " 2. Run: opencli doctor"
42+
Write-Host ' 3. Trigger the skill with: Use $opencli to inspect the installed OpenCLI surface and run a read-first workflow.'

0 commit comments

Comments
 (0)