gavindiaz/gmgn-skills
1
0
Fork 0
mirror of https://github.com/GMGNAI/gmgn-skills.git synced 2026-08-25 22:18:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: sync and align EN/ZH README content

Browse Source 
- Fix duplicate Section 8 numbering (Supported Chains→9, Upgrade→10, Security→11)
- Add missing `npm install -g gmgn-cli` to Upgrade (AI Agent) blocks in both files
- English Section 8: replace `npx gmgn-cli` with `gmgn-cli` per CLAUDE.md rules
- English Section 8: expand Portfolio examples (activity/stats/info/token-balance)
- English Section 8: add Swap percent-sell and order-quote examples
- English Section 6: expand usage examples from 8 to 19 entries (align with ZH)
- Chinese Section 2: remove AI-Agent verification method, keep direct CLI only
- Chinese: remove redundant "开始安装 Skills" section

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
gumponchain
2026-03-31 16:47:47 +08:00
committed by GMGN.AI
co-authored by Claude Sonnet 4.6
parent 5ec76cb465
commit d2a91ef7d1
2 changed files with 75 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Readme.md
+67 -21
View File
@@ -99,7 +99,7 @@ No more scraping web pages or getting blocked by Cloudflare. Query all the profe
Ready to install? [Jump to Installation →](#1-installation) Ready to install? [Jump to Installation →](#1-installation)
Already installed? [Upgrade Skills and CLI →](#9-upgrade-skills-and-cli) Already installed? [Upgrade Skills and CLI →](#10-upgrade-skills-and-cli)
> **Tip:** If your AI agent tries to open or scrape the gmgn.ai website instead of using the CLI, add this to your prompt: `Use gmgn-cli commands. Do not call gmgn.ai web endpoints directly.` > **Tip:** If your AI agent tries to open or scrape the gmgn.ai website instead of using the CLI, add this to your prompt: `Use gmgn-cli commands. Do not call gmgn.ai web endpoints directly.`
@@ -176,9 +176,10 @@ If output appears without error, setup is complete.
## Upgrade (AI Agent) ## Upgrade (AI Agent)
> Run this command to upgrade both the CLI and Skills to the latest version. > Run these two commands to upgrade both the CLI and Skills to the latest version.
```bash ```bash
npm install -g gmgn-cli
npx skills add GMGNAI/gmgn-skills npx skills add GMGNAI/gmgn-skills
``` ```
@@ -188,7 +189,7 @@ Check the installed version after upgrading:
gmgn-cli --version gmgn-cli --version
``` ```
> For the full upgrade reference, see [Section 9 — Upgrade Skills and CLI](#9-upgrade-skills-and-cli). > For the full upgrade reference, see [Section 9 — Upgrade Skills and CLI](#10-upgrade-skills-and-cli).
--- ---
@@ -373,12 +374,23 @@ Natural language prompts you can send to any AI assistant with gmgn-cli skills i
``` ```
buy 0.1 SOL of <token_address> buy 0.1 SOL of <token_address>
sell 50% of <token_address> on BSC sell 50% of <token_address> on BSC
sell 30% of my <token_address> position
get a quote: how much <token_address> can I get for 1 SOL?
check order status <order_id> check order status <order_id>
is <token_address> safe to buy on solana? is <token_address> safe to buy on solana?
show top holders of <token_address> show top holders of <token_address>
show smart money holdings of <token_address>, sorted by buy volume
show recent KOL trades for <token_address>
show my wallet holdings on SOL show my wallet holdings on SOL
query token details for 0x1234... query token details for 0x1234...
show 24h K-line and volume for <token_address>
show trading stats for wallet <wallet_address> on BSC show trading stats for wallet <wallet_address> on BSC
show recent trades for wallet <wallet_address>
which wallets are linked to my API key, and what are their balances
show the latest smart money trades on SOL
show what KOLs are buying on SOL
show newly launched tokens on Solana
show Solana 1-minute trending tokens
``` ```
### Typical Workflows ### Typical Workflows
@@ -428,26 +440,26 @@ Full parameter reference: [docs/cli-usage.md](docs/cli-usage.md). All commands s
### Token ### Token
```bash ```bash
npx gmgn-cli token info --chain sol --address <addr> gmgn-cli token info --chain sol --address <addr>
``` ```
### Market ### Market
```bash ```bash
npx gmgn-cli market trending \ gmgn-cli market trending \
--chain sol \ --chain sol \
--interval 1h \ --interval 1h \
--order-by volume --limit 20 \ --order-by volume --limit 20 \
--filter not_risk --filter not_honeypot --filter not_risk --filter not_honeypot
npx gmgn-cli market trenches \ gmgn-cli market trenches \
--chain sol \ --chain sol \
--type new_creation --type near_completion --type completed \ --type new_creation --type near_completion --type completed \
--launchpad-platform Pump.fun --launchpad-platform pump_mayhem --launchpad-platform letsbonk \ --launchpad-platform Pump.fun --launchpad-platform pump_mayhem --launchpad-platform letsbonk \
--limit 80 --limit 80
# With server-side filters: safe preset + require smart money + sort by smart degen count # With server-side filters: safe preset + require smart money + sort by smart degen count
npx gmgn-cli market trenches \ gmgn-cli market trenches \
--chain sol --type new_creation \ --chain sol --type new_creation \
--filter-preset safe --min-smart-degen-count 1 --sort-by smart_degen_count --filter-preset safe --min-smart-degen-count 1 --sort-by smart_degen_count
``` ```
@@ -455,30 +467,43 @@ npx gmgn-cli market trenches \
### Portfolio ### Portfolio
```bash ```bash
npx gmgn-cli portfolio holdings --chain sol --wallet <addr> # Holdings
gmgn-cli portfolio holdings --chain sol --wallet <addr>
# Activity
gmgn-cli portfolio activity --chain sol --wallet <addr>
# Stats (supports multiple wallets)
gmgn-cli portfolio stats --chain sol --wallet <addr1> --wallet <addr2>
# Wallets and balances linked to API key
gmgn-cli portfolio info
# Single token balance
gmgn-cli portfolio token-balance --chain sol --wallet <addr> --token <token_addr>
``` ```
### Track ### Track
```bash ```bash
# Follow-wallet trade records (requires GMGN_PRIVATE_KEY) # Follow-wallet trade records (requires GMGN_PRIVATE_KEY)
npx gmgn-cli track follow-wallet --chain sol gmgn-cli track follow-wallet --chain sol
npx gmgn-cli track follow-wallet --chain sol --wallet <wallet_address> --side buy gmgn-cli track follow-wallet --chain sol --wallet <wallet_address> --side buy
# KOL trade records # KOL trade records
npx gmgn-cli track kol --limit 100 --raw gmgn-cli track kol --limit 100 --raw
npx gmgn-cli track kol --chain sol --side buy --limit 50 --raw gmgn-cli track kol --chain sol --side buy --limit 50 --raw
# Smart Money trade records # Smart Money trade records
npx gmgn-cli track smartmoney --limit 100 --raw gmgn-cli track smartmoney --limit 100 --raw
npx gmgn-cli track smartmoney --chain sol --side sell --limit 50 --raw gmgn-cli track smartmoney --chain sol --side sell --limit 50 --raw
``` ```
### Swap (requires private key) ### Swap (requires private key)
```bash ```bash
# Submit swap with fixed slippage # Submit swap with fixed slippage
npx gmgn-cli swap \ gmgn-cli swap \
--chain sol \ --chain sol \
--from <wallet-address> \ --from <wallet-address> \
--input-token <input-token-addr> \ --input-token <input-token-addr> \
@@ -487,7 +512,7 @@ npx gmgn-cli swap \
--slippage 0.01 --slippage 0.01
# Submit swap with automatic slippage # Submit swap with automatic slippage
npx gmgn-cli swap \ gmgn-cli swap \
--chain sol \ --chain sol \
--from <wallet-address> \ --from <wallet-address> \
--input-token <input-token-addr> \ --input-token <input-token-addr> \
@@ -495,11 +520,29 @@ npx gmgn-cli swap \
--amount 1000000 \ --amount 1000000 \
--auto-slippage --auto-slippage
# Sell by position percentage (e.g. sell 50%)
gmgn-cli swap \
--chain sol \
--from <wallet-address> \
--input-token <token-addr> \
--output-token <usdc-addr> \
--percent 50 \
--auto-slippage
# Get quote (no transaction submitted)
gmgn-cli order quote \
--chain sol \
--from <wallet-address> \
--input-token <input-token-addr> \
--output-token <output-token-addr> \
--amount 1000000 \
--slippage 0.01
# Query order # Query order
npx gmgn-cli order get --chain sol --order-id <order-id> gmgn-cli order get --chain sol --order-id <order-id>
``` ```
## 8. Supported Chains ## 9. Supported Chains
| Commands | Chains | Chain Currencies | | Commands | Chains | Chain Currencies |
|----------|--------|-----------------| |----------|--------|-----------------|
@@ -508,10 +551,13 @@ npx gmgn-cli order get --chain sol --order-id <order-id>
--- ---
## 9. Upgrade Skills and CLI ## 10. Upgrade Skills and CLI
```bash ```bash
# Upgrade CLI and Skills # Upgrade CLI
npm install -g gmgn-cli
# Upgrade Skills
npx skills add GMGNAI/gmgn-skills npx skills add GMGNAI/gmgn-skills
# Check current version # Check current version
@@ -522,7 +568,7 @@ gmgn-cli --version
--- ---
## 10. Security & Disclaimer (Read Before Use) ## 11. Security & Disclaimer (Read Before Use)
This tool can be invoked by an AI Agent to submit real on-chain transactions automatically. It carries inherent risks including model hallucination, uncontrolled execution, and prompt injection. Once authorized, the AI Agent will submit transactions on behalf of your linked wallet address — **on-chain transactions are irreversible once confirmed** and may result in financial loss. Use with caution. This tool can be invoked by an AI Agent to submit real on-chain transactions automatically. It carries inherent risks including model hallucination, uncontrolled execution, and prompt injection. Once authorized, the AI Agent will submit transactions on behalf of your linked wallet address — **on-chain transactions are irreversible once confirmed** and may result in financial loss. Use with caution.
Readme.zh.md
+8 -26
View File
@@ -102,7 +102,7 @@ SOL / BSC / Base 多链数据每次查询均为实时，支持多参数个性化
已准备好？[点击这里开始安装 Skills →](#开始安装-skills) 已准备好？[点击这里开始安装 Skills →](#开始安装-skills)
已安装？[升级 Skills 和 CLI →](#9-升级-skills-和-cli) 已安装？[升级 Skills 和 CLI →](#10-升级-skills-和-cli)
> **提示：** 如果你的 AI Agent 尝试直接打开 gmgn.ai 网站而不是使用 CLI，请在提示词中加上： > **提示：** 如果你的 AI Agent 尝试直接打开 gmgn.ai 网站而不是使用 CLI，请在提示词中加上：
> ``` > ```
@@ -182,9 +182,10 @@ gmgn-cli market trending --chain sol --interval 1h --limit 3
## AI Agent 升级 ## AI Agent 升级
> 运行以下命令，将 CLI 和 Skills 同时升级到最新版本。 > 运行以下两条命令，将 CLI 和 Skills 同时升级到最新版本。
```bash ```bash
npm install -g gmgn-cli
npx skills add GMGNAI/gmgn-skills npx skills add GMGNAI/gmgn-skills
``` ```
@@ -194,7 +195,7 @@ npx skills add GMGNAI/gmgn-skills
gmgn-cli --version gmgn-cli --version
``` ```
> 完整升级说明请参阅[第 9 节 — 升级 Skills 和 CLI](#9-升级-skills-和-cli)。 > 完整升级说明请参阅[第 10 节 — 升级 Skills 和 CLI](#10-升级-skills-和-cli)。
--- ---
@@ -223,15 +224,6 @@ gmgn-cli --version
--- ---
## 开始安装 Skills
安装前，请先在 **https://gmgn.ai/ai** 创建 API Key，用于：
1. 读取数据：代币、榜单、K 线、特色数据指标
2. 提交交易：市价立即交易、创建限价单、策略单等
---
## 1. 安装 ## 1. 安装
选择以下任意一种方式 选择以下任意一种方式
@@ -260,20 +252,10 @@ node dist/index.js <command> [options]
## 2. 验证连通性 ## 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 测试，无需注册： 使用公共 API Key 测试，无需注册：
```bash ```bash
GMGN_API_KEY=gmgn_solbscbaseethmonadtron npx gmgn-cli market trending --chain sol --interval 1h --limit 3 GMGN_API_KEY=gmgn_solbscbaseethmonadtron gmgn-cli market trending --chain sol --interval 1h --limit 3
``` ```
看到 JSON 输出即表示 CLI 正常工作。公共 Key 支持所有只读接口（token / market / portfolio），公共 Key 仅用于测试，正式使用任何接口均需申请个人 API Key（见第 3 步）。 看到 JSON 输出即表示 CLI 正常工作。公共 Key 支持所有只读接口（token / market / portfolio），公共 Key 仅用于测试，正式使用任何接口均需申请个人 API Key（见第 3 步）。
@@ -592,7 +574,7 @@ gmgn-cli order quote \
gmgn-cli order get --chain sol --order-id <order-id> gmgn-cli order get --chain sol --order-id <order-id>
``` ```
## 8. 支持的链 ## 9. 支持的链
| 接口类型 | 支持的链 | 链原生货币 | | 接口类型 | 支持的链 | 链原生货币 |
|----------|----------|-----------| |----------|----------|-----------|
@@ -601,7 +583,7 @@ gmgn-cli order get --chain sol --order-id <order-id>
--- ---
## 9. 升级 Skills 和 CLI ## 10. 升级 Skills 和 CLI
将 `gmgn-cli` 和 Skills 升级到最新版本： 将 `gmgn-cli` 和 Skills 升级到最新版本：
@@ -633,7 +615,7 @@ gmgn-cli --version
--- ---
## 10. 安全与免责（使用前必读） ## 11. 安全与免责（使用前必读）
本工具可供 AI Agent 调用以自动执行链上交易，存在模型幻觉、执行不可控、提示词注入等固有风险。AI Agent 在获得授权后，将以您绑定的钱包地址提交真实的链上交易，**交易一经上链即不可撤销**，可能导致资金损失，请您谨慎使用。 本工具可供 AI Agent 调用以自动执行链上交易，存在模型幻觉、执行不可控、提示词注入等固有风险。AI Agent 在获得授权后，将以您绑定的钱包地址提交真实的链上交易，**交易一经上链即不可撤销**，可能导致资金损失，请您谨慎使用。