mirror of
https://github.com/GMGNAI/gmgn-skills.git
synced 2026-07-27 16:57:44 +00:00
docs: update README structure, add demo cases and screenshots
- Restructure README (EN + ZH): reorder sections, unify sub-heading format - Add Demo Cases section with two annotated examples and screenshots - Add static/ folder with all screenshots and header image - Add Quick Start anchor link from Skills section to installation - Split Verify Connection into AI Agent and CLI options - Rename Prerequisites → Get Started / 准备工作 → 开始安装 Skills
This commit is contained in:
gumponchain
+154
-74
@@ -1,8 +1,16 @@
|
||||
# gmgn-cli
|
||||
<div align="center">
|
||||
|
||||
> English: [Readme.md](Readme.md)
|
||||
<img src="static/gmgnagentskills.png" alt="GMGN Agent Skills" />
|
||||
|
||||
GMGN 链上操作 AI 技能套件 — Token 研究、行情数据、钱包分析和交易。
|
||||
[](https://x.com/gmgnai) [](https://t.me/gmgnagentapi) [](https://discord.gg/gmgnai)
|
||||
|
||||
[English](Readme.md) | 简体中文
|
||||
|
||||
</div>
|
||||
|
||||
## GMGN Agent Skills
|
||||
|
||||
使用 GMGN Agent Skills，你可以通过 AI Agent 实时查询多个链上热门代币排行榜，代币基础信息，社交媒体信息，实时交易动态，实时战壕新币，报持仓大户（Top Holder），交易大户（Top Trader），聪明钱持仓占比，KOL持仓占比，老鼠仓持仓，捆绑持仓占比，等代币专业数据分析数据，以及支持代币市价单交易、限价单交易、高级止盈止损策略单交易，以及钱包资产管理相关功能，例如查询钱包实时持仓、钱包最近盈亏、钱包交易动态等，全部通过自然语言与 AI Agent 交互即可完成。
|
||||
|
||||
---
|
||||
|
||||
@@ -15,50 +23,127 @@ GMGN 链上操作 AI 技能套件 — Token 研究、行情数据、钱包分析
|
||||
| [`/gmgn-portfolio`](skills/gmgn-portfolio/SKILL.md) | 钱包持仓、活动、统计 | [SKILL.md](skills/gmgn-portfolio/SKILL.md) |
|
||||
| [`/gmgn-swap`](skills/gmgn-swap/SKILL.md) | 兑换提交 + 订单查询 | [SKILL.md](skills/gmgn-swap/SKILL.md) |
|
||||
|
||||
---
|
||||
> 如需查看详细的 CLI 接口说明、传参格式和推荐值，请参阅 [Wiki 文档](https://github.com/GMGNAI/gmgn-skills/wiki/Home-Chinese)。
|
||||
|
||||
## 用法示例
|
||||
### 快速开始安装
|
||||
|
||||
安装技能后，向 AI 助手直接发送自然语言指令：
|
||||
|
||||
```
|
||||
buy 0.1 SOL of <token_address>
|
||||
sell 50% of <token_address> on BSC
|
||||
check order status <order_id>
|
||||
is <token_address> safe to buy on solana?
|
||||
show top holders of <token_address>
|
||||
show my wallet holdings on SOL
|
||||
query token details for 0x1234...
|
||||
show trading stats for wallet <wallet_address> on BSC
|
||||
```
|
||||
已准备好？[点击这里开始安装 Skills →](#开始安装-skills)
|
||||
|
||||
---
|
||||
|
||||
## 安装配置
|
||||
## 使用案例
|
||||
|
||||
### 0. 准备工作
|
||||
### 查询热门代币榜
|
||||
|
||||
申请 API Key 前，需要先准备两件事：
|
||||
发送下面提示词给 AI Agent：
|
||||
|
||||
**生成 Ed25519 密钥对**
|
||||
```
|
||||
查 Solana 1h 热门榜，筛出 6 小时内创建的新币，并且platforms是pump.fun的代币，然后按交易量从高到低排列。
|
||||
```
|
||||
|
||||
下载并运行 [Binance Asymmetric Key Generator](https://github.com/binance/asymmetric-key-generator/releases)。申请 API Key 时需要填入**公钥**，**私钥**稍后配置到 `.env`（swap / order 接口使用）。
|
||||
|
||||
|
||||
**获取本机出口 IP**（用于填写 IP 白名单）
|
||||
### 实时分析代币交易走势
|
||||
|
||||
发送下面提示词给 AI Agent：
|
||||
|
||||
```
|
||||
查看第一个代币的 K 线，分析入场时机，并提供社交媒体链接以及聪明资金 / KOL 的交易分析。
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 开始安装 Skills
|
||||
|
||||
安装前，请先在 **https://gmgn.ai/ai** 创建 API Key，用于：
|
||||
|
||||
1. 读取数据：代币、榜单、K 线、特色数据指标
|
||||
2. 提交交易：市价立即交易、创建限价单、策略单等
|
||||
|
||||
---
|
||||
|
||||
## 1. 安装
|
||||
|
||||
选择以下任意一种方式：
|
||||
|
||||
### 1.1 通过 Agent 安装（推荐）
|
||||
|
||||
发送给你的 AI Agent：
|
||||
|
||||
```bash
|
||||
npx skills add GMGNAI/gmgn-skills
|
||||
```
|
||||
|
||||
### 1.2 npm 全局安装
|
||||
|
||||
```bash
|
||||
npm install -g gmgn-cli@1.0.1
|
||||
```
|
||||
|
||||
### 1.3 本地开发
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run build
|
||||
node dist/index.js <command> [options]
|
||||
```
|
||||
|
||||
## 2. 验证连通性
|
||||
|
||||
### 方式一：通过 AI Agent 验证
|
||||
|
||||
发送以下提示词给你的 AI Agent：
|
||||
|
||||
```
|
||||
执行这个cli命令：GMGN_API_KEY=gmgn_solbscbaseethmonadtron npx gmgn-cli market trending --chain sol --interval 1h --limit 3
|
||||
```
|
||||
|
||||
### 方式二：通过 CLI 验证
|
||||
|
||||
使用公共 API Key 测试，无需注册：
|
||||
|
||||
```bash
|
||||
GMGN_API_KEY=gmgn_solbscbaseethmonadtron npx gmgn-cli market trending --chain sol --interval 1h --limit 3
|
||||
```
|
||||
|
||||
看到 JSON 输出即表示 CLI 正常工作。公共 Key 支持所有只读接口（token / market / portfolio），公共 Key 仅用于测试，正式使用任何接口均需申请个人 API Key（见第 3 步）。
|
||||
|
||||
## 3. 申请个人 API Key
|
||||
|
||||
第 2 步的公共 Key 仅用于测试。正式使用（只读接口和 swap）均需在 https://gmgn.ai/ai 申请个人 API Key，需要准备：
|
||||
|
||||
### 3.1 生成 Ed25519 密钥对
|
||||
|
||||
**方式一：输入提示词（推荐）**
|
||||
|
||||
将以下提示词发送给你的 AI Agent：
|
||||
|
||||
```
|
||||
帮我用 OpenSSL 生成一个 Ed25519 密钥对，并分别显示给我：
|
||||
1. 公钥（我需要填写到GMGN网站上的 API Key 创建表单中）
|
||||
2. PEM 格式的私钥（我需要将它设置为 .env 中的 GMGN_PRIVATE_KEY）
|
||||
```
|
||||
|
||||
**方式二：Binance Key Generator**
|
||||
|
||||
下载并运行 [Binance Asymmetric Key Generator](https://github.com/binance/asymmetric-key-generator/releases)。
|
||||
|
||||
申请时填入**公钥**。
|
||||
|
||||
### 3.2 获取本机出口 IP
|
||||
|
||||
用于填写 IP 白名单（开通 API Key 的交易能力时需要）：
|
||||
|
||||
```bash
|
||||
curl ip.me
|
||||
```
|
||||
|
||||
或在浏览器访问 **https://ip.me**。
|
||||
## 4. 配置个人 API Key
|
||||
|
||||
### 1. 获取 API Key
|
||||
|
||||
申请地址：**https://gmgn.ai/ai** — 填入上一步准备好的公钥和 IP 地址。
|
||||
|
||||
### 2. 配置
|
||||
|
||||
**方式 A — 全局配置（推荐）**
|
||||
### 方式一：全局配置（推荐）
|
||||
|
||||
创建 `~/.config/gmgn/.env`，配置一次，所有目录均生效：
|
||||
|
||||
@@ -67,12 +152,12 @@ mkdir -p ~/.config/gmgn
|
||||
cat > ~/.config/gmgn/.env << 'EOF'
|
||||
GMGN_API_KEY=your_api_key_here
|
||||
|
||||
# swap / order 接口额外需要（第 0 步生成的私钥）：
|
||||
# 仅 swap / order 接口需要：
|
||||
GMGN_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n<base64>\n-----END PRIVATE KEY-----\n"
|
||||
EOF
|
||||
```
|
||||
|
||||
**方式 B — 项目 `.env`**
|
||||
### 方式二：项目 `.env`
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
@@ -81,24 +166,16 @@ cp .env.example .env
|
||||
|
||||
配置加载顺序：`~/.config/gmgn/.env` → 项目 `.env`（项目级优先）。
|
||||
|
||||
### 3. CLI 安装
|
||||
## 5. 在 AI 客户端中使用
|
||||
|
||||
安装固定版本，避免运行时拉取未经验证的更新：
|
||||
#### OpenClaw
|
||||
|
||||
直接发送以下提示词，测试查询能力：
|
||||
|
||||
```bash
|
||||
npm install -g gmgn-cli@1.0.1
|
||||
```
|
||||
|
||||
本地开发：
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run build
|
||||
node dist/index.js <command> [options]
|
||||
查询 Solana 链 1 小时热门代币
|
||||
```
|
||||
|
||||
### 4. 接入 AI 工具
|
||||
|
||||
#### Claude Code
|
||||
|
||||
安装包后通过插件机制自动发现技能。
|
||||
@@ -107,19 +184,17 @@ node dist/index.js <command> [options]
|
||||
|
||||
技能通过 `.cursor-plugin/` 配置自动发现。
|
||||
|
||||
1. 完成上方步骤 1–3
|
||||
2. 配置凭证：`~/.config/gmgn/.env`
|
||||
3. 重启 Cursor — Agent 模式下可通过 `/gmgn-*` 命令使用技能
|
||||
1. 完成上方安装和配置步骤
|
||||
2. 重启 Cursor — Agent 模式下可通过 `/gmgn-*` 命令使用技能
|
||||
|
||||
#### Cline
|
||||
|
||||
1. 完成上方步骤 1–3
|
||||
1. 完成上方安装和配置步骤
|
||||
2. 在 Cline 设置 → **Skills directory**：填入已安装包的 `skills/` 目录路径：
|
||||
```bash
|
||||
echo "$(npm root -g)/gmgn-skills/skills"
|
||||
```
|
||||
3. 配置凭证：`~/.config/gmgn/.env`
|
||||
4. 重启 Cline — `/gmgn-token`、`/gmgn-market`、`/gmgn-portfolio`、`/gmgn-swap` 即可使用
|
||||
3. 重启 Cline — `/gmgn-token`、`/gmgn-market`、`/gmgn-portfolio`、`/gmgn-swap` 即可使用
|
||||
|
||||
#### Codex CLI
|
||||
|
||||
@@ -143,33 +218,50 @@ ln -s ~/.opencode/gmgn-cli/skills ~/.agents/skills/gmgn-cli
|
||||
|
||||
---
|
||||
|
||||
## 典型使用场景
|
||||
## 6. 使用示例
|
||||
|
||||
### 常用指令
|
||||
|
||||
安装技能后，向 AI 助手直接发送自然语言指令：
|
||||
|
||||
```
|
||||
用 0.1 SOL 买入 <token_address>
|
||||
卖出 BSC 上 <token_address> 的 50%
|
||||
查询订单状态 <order_id>
|
||||
solana 上的 <token_address> 安全吗，值得买入吗？
|
||||
查看 <token_address> 的前十大持有者
|
||||
查看我在 SOL 上的钱包持仓
|
||||
查询 0x1234... 的代币详情
|
||||
查看 BSC 上钱包 <wallet_address> 的交易统计
|
||||
```
|
||||
|
||||
### 典型使用场景
|
||||
|
||||
**研究 Token：**
|
||||
```
|
||||
token info → token security → token pool → token holders
|
||||
查询代币信息 → 查询安全指标 → 查询流动池 → 查询持有者
|
||||
```
|
||||
|
||||
**分析钱包：**
|
||||
```
|
||||
portfolio holdings → portfolio stats → portfolio activity
|
||||
查询钱包持仓 → 查询交易统计 → 查询交易记录
|
||||
```
|
||||
|
||||
**执行交易：**
|
||||
```
|
||||
token info（确认 Token） → portfolio token-balance（检查余额） → swap → order get（轮询状态）
|
||||
确认代币信息 → 检查余额 → 提交兑换 → 轮询订单状态
|
||||
```
|
||||
|
||||
**通过 Trending 发现交易机会：**
|
||||
**通过热门榜单发现交易机会：**
|
||||
```
|
||||
market trending（取 50 条） → AI 多维度分析选出 top 5 → 用户确认 → token info / token security → swap
|
||||
获取热门代币（50 条） → AI 多维度分析选出 top 5 → 用户确认 → 查询代币信息 / 安全指标 → 提交兑换
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## CLI 参考
|
||||
## 7. CLI 参考
|
||||
|
||||
完整参数说明：[docs/cli-usage.md](docs/cli-usage.md)
|
||||
完整参数说明：[docs/cli-usage.md](docs/cli-usage.md)。所有命令均支持 `--raw` 输出单行 JSON（方便 `jq` 等工具处理）。
|
||||
|
||||
### Token
|
||||
|
||||
@@ -209,9 +301,7 @@ npx gmgn-cli swap \
|
||||
npx gmgn-cli order get --chain sol --order-id <order-id>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 支持的链
|
||||
## 8. 支持的链
|
||||
|
||||
| 接口类型 | 支持的链 | 链原生货币 |
|
||||
|----------|----------|-----------|
|
||||
@@ -220,17 +310,7 @@ npx gmgn-cli order get --chain sol --order-id <order-id>
|
||||
|
||||
---
|
||||
|
||||
## 输出格式
|
||||
|
||||
默认输出格式化 JSON。使用 `--raw` 输出单行 JSON（方便 jq 等工具处理）：
|
||||
|
||||
```bash
|
||||
npx gmgn-cli token info --chain sol --address <addr> --raw | jq '.price'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 安全与免责
|
||||
## 9. 安全与免责
|
||||
|
||||
**关于 `GMGN_PRIVATE_KEY`**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user