@byreal-io/byreal-cli-realclaw 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,88 @@
1
+ # Byreal Agent Skills
2
+
3
+ > **Note:** This is the **openclaw** internal branch. Write commands output unsigned base64 transactions by default and require `--wallet-address <address>` instead of local keypair setup.
4
+
5
+ Agent skills for [Byreal](https://byreal.io) — a concentrated liquidity (CLMM) DEX on Solana. Every command supports structured JSON output, and the built-in skill system lets AI agents discover and use all capabilities automatically.
6
+
7
+ ## AI Integration
8
+
9
+ Install as an **Agent Skill** so your LLM can discover all capabilities:
10
+
11
+ ```bash
12
+ npx skills add https://github.com/byreal-git/byreal-agent-skills/tree/openclaw
13
+ ```
14
+
15
+ Or install the CLI only:
16
+
17
+ ```bash
18
+ npm install -g @byreal-io/byreal-cli-realclaw
19
+ ```
20
+
21
+ ## Features
22
+
23
+ - **Pools** — List, search, and inspect CLMM pools. View K-line charts, APR, TVL, volume, and run comprehensive pool analysis (risk, volatility, range recommendations).
24
+ - **Tokens** — List tokens, search by symbol/name, get real-time prices.
25
+ - **Swap** — Preview and execute token swaps with slippage control and price impact estimation.
26
+ - **Positions** — Open, close, and manage CLMM positions. Claim fees and rewards. Analyze position performance. Copy top farmers' positions with one command.
27
+ - **Wallet** — Query wallet balance.
28
+ - **Config** — Configure RPC URL, slippage tolerance, priority fees.
29
+
30
+ ## Quick Start
31
+
32
+ ```bash
33
+ # View top pools by APR
34
+ byreal-cli pools list --sort-field apr24h
35
+
36
+ # Analyze a pool
37
+ byreal-cli pools analyze <pool-address>
38
+
39
+ # Swap 0.1 SOL → USDC (preview)
40
+ byreal-cli swap execute \
41
+ --wallet-address <your-wallet-address> \
42
+ --input-mint So11111111111111111111111111111111111111112 \
43
+ --output-mint EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v \
44
+ --amount 0.1 --dry-run
45
+
46
+ # Copy a top farmer's position (outputs unsigned base64 transaction)
47
+ byreal-cli positions copy \
48
+ --wallet-address <your-wallet-address> \
49
+ --position <address> --amount-usd 100
50
+ ```
51
+
52
+ All commands support `-o json` for structured output.
53
+
54
+ ## Commands
55
+
56
+ | Command | Description |
57
+ | ------------------------- | ---------------------------------------------- |
58
+ | `overview` | Global DEX statistics (TVL, volume, fees) |
59
+ | `pools list` | List pools with sorting and filtering |
60
+ | `pools info` | Detailed pool information |
61
+ | `pools klines` | K-line / candlestick chart |
62
+ | `pools analyze` | Comprehensive pool analysis (APR, risk, range) |
63
+ | `tokens list` | List available tokens |
64
+ | `swap execute` | Preview or execute a token swap |
65
+ | `positions list` | List your CLMM positions |
66
+ | `positions open` | Open a new CLMM position |
67
+ | `positions increase` | Add liquidity to an existing position |
68
+ | `positions decrease` | Partially remove liquidity from a position |
69
+ | `positions close` | Close a position |
70
+ | `positions claim` | Claim trading fees |
71
+ | `positions claim-rewards` | Claim incentive rewards from positions |
72
+ | `positions claim-bonus` | Claim CopyFarmer bonus rewards |
73
+ | `positions analyze` | Analyze an existing position |
74
+ | `positions top-positions` | View top positions in a pool |
75
+ | `positions copy` | Copy a farmer's position |
76
+ | `wallet balance` | Query wallet balance |
77
+ | `update check` | Check for CLI updates |
78
+
79
+ ## Update
80
+
81
+ ```bash
82
+ byreal-cli update check
83
+ byreal-cli update install
84
+ ```
85
+
86
+ ## License
87
+
88
+ MIT