Skip to content

Commit c4829f2

Browse files
committed
Make README skill-first
1 parent b15af33 commit c4829f2

2 files changed

Lines changed: 52 additions & 52 deletions

File tree

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,33 @@ Some write-heavy and advanced type-editing operations still require further pari
6060

6161
## Quick Start
6262

63-
### Install `ida-cli`
63+
### Recommended Path: Install the Skill
6464

65-
Recommended: use the installer script. It downloads the latest tagged release when one exists, otherwise it can fall back to a local source build.
65+
The default entrypoint is the `ida-cli` skill, not a manual CLI install.
66+
67+
```bash
68+
# List the skill exposed by this repository
69+
npx -y skills add https://github.com/cpkt9762/ida-cli --list
70+
71+
# Install the ida-cli skill for Codex
72+
npx -y skills add https://github.com/cpkt9762/ida-cli --skill ida-cli --agent codex --yes --global
73+
```
74+
75+
This was verified locally: the CLI detected the `ida-cli` skill from `skill/SKILL.md` and installed it to `~/.agents/skills/ida-cli`.
76+
77+
After installation, the skill ships its own bootstrap wrapper:
78+
79+
```bash
80+
~/.agents/skills/ida-cli/scripts/ida-cli.sh --help
81+
~/.agents/skills/ida-cli/scripts/ida-cli.sh probe-runtime
82+
~/.agents/skills/ida-cli/scripts/ida-cli.sh --path /path/to/binary list-functions --limit 20
83+
```
84+
85+
That wrapper installs `ida-cli` automatically if it is missing, then runs the requested command.
86+
87+
### Direct CLI Install (Optional)
88+
89+
Use this only if you want the standalone CLI without going through the skill.
6690

6791
```bash
6892
curl -fsSL https://raw.githubusercontent.com/cpkt9762/ida-cli/master/scripts/install.sh | bash -s -- --add-path
@@ -122,30 +146,6 @@ Example backend selections:
122146
{"runtime":{"major":9,"minor":3,"build":260213},"backend":"native-linked","supported":true,"reason":null}
123147
```
124148

125-
### Install the skill
126-
127-
The tested command is `npx skills add`, not `npx skill add`.
128-
129-
```bash
130-
# List the skill exposed by this repository
131-
npx -y skills add https://github.com/cpkt9762/ida-cli --list
132-
133-
# Install the ida-cli skill for Codex
134-
npx -y skills add https://github.com/cpkt9762/ida-cli --skill ida-cli --agent codex --yes --global
135-
```
136-
137-
This was verified locally: the CLI detected the `ida-cli` skill from `skill/SKILL.md` and installed it to `~/.agents/skills/ida-cli`.
138-
139-
After installation, the skill ships its own bootstrap wrapper:
140-
141-
```bash
142-
~/.agents/skills/ida-cli/scripts/ida-cli.sh --help
143-
~/.agents/skills/ida-cli/scripts/ida-cli.sh probe-runtime
144-
~/.agents/skills/ida-cli/scripts/ida-cli.sh --path /path/to/binary list-functions --limit 20
145-
```
146-
147-
That wrapper installs `ida-cli` automatically if it is missing, then runs the requested command.
148-
149149
## Build Requirements
150150

151151
- Rust 1.77+

README.zh-CN.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,33 @@
6060

6161
## 快速开始
6262

63-
### 安装 `ida-cli`
63+
### 最推荐路径:直接安装 skill
6464

65-
推荐直接用安装脚本。它会优先拉取最新 release;如果当前没有可用二进制资产,也可以回退到本地源码构建。
65+
默认入口应该是 `ida-cli` skill,而不是手动先装 CLI。
66+
67+
```bash
68+
# 查看这个仓库暴露出来的 skill
69+
npx -y skills add https://github.com/cpkt9762/ida-cli --list
70+
71+
# 给 Codex 安装 ida-cli skill
72+
npx -y skills add https://github.com/cpkt9762/ida-cli --skill ida-cli --agent codex --yes --global
73+
```
74+
75+
这条链路我已经本地验证过,CLI 能正确识别 `skill/SKILL.md` 里的 `ida-cli`,并安装到 `~/.agents/skills/ida-cli`
76+
77+
安装完成后,skill 自带一个 bootstrap wrapper:
78+
79+
```bash
80+
~/.agents/skills/ida-cli/scripts/ida-cli.sh --help
81+
~/.agents/skills/ida-cli/scripts/ida-cli.sh probe-runtime
82+
~/.agents/skills/ida-cli/scripts/ida-cli.sh --path /path/to/binary list-functions --limit 20
83+
```
84+
85+
这个 wrapper 会在本机缺少 `ida-cli` 时自动安装,然后再执行实际命令。
86+
87+
### 直接安装 CLI(可选)
88+
89+
只有你明确想单独使用 CLI,而不是通过 skill 时,再走这条路。
6690

6791
```bash
6892
curl -fsSL https://raw.githubusercontent.com/cpkt9762/ida-cli/master/scripts/install.sh | bash -s -- --add-path
@@ -122,30 +146,6 @@ cargo build --bin ida-cli
122146
{"runtime":{"major":9,"minor":3,"build":260213},"backend":"native-linked","supported":true,"reason":null}
123147
```
124148

125-
### 安装 skill
126-
127-
这里实测可用的是 `npx skills add`,不是 `npx skill add`
128-
129-
```bash
130-
# 查看这个仓库暴露出来的 skill
131-
npx -y skills add https://github.com/cpkt9762/ida-cli --list
132-
133-
# 给 Codex 安装 ida-cli skill
134-
npx -y skills add https://github.com/cpkt9762/ida-cli --skill ida-cli --agent codex --yes --global
135-
```
136-
137-
这条链路我已经本地验证过,CLI 能正确识别 `skill/SKILL.md` 里的 `ida-cli`,并安装到 `~/.agents/skills/ida-cli`
138-
139-
安装完成后,skill 自带一个 bootstrap wrapper:
140-
141-
```bash
142-
~/.agents/skills/ida-cli/scripts/ida-cli.sh --help
143-
~/.agents/skills/ida-cli/scripts/ida-cli.sh probe-runtime
144-
~/.agents/skills/ida-cli/scripts/ida-cli.sh --path /path/to/binary list-functions --limit 20
145-
```
146-
147-
这个 wrapper 会在本机缺少 `ida-cli` 时自动安装,然后再执行实际命令。
148-
149149
## 构建要求
150150

151151
- Rust 1.77+

0 commit comments

Comments
 (0)