@covalenthq/goldrush-cli 3.0.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/LICENSE +21 -0
- package/README.md +65 -0
- package/dist/index.js +7150 -0
- package/dist/index.js.map +1 -0
- package/package.json +76 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Covalent
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# @covalenthq/goldrush-cli
|
|
2
|
+
|
|
3
|
+
Terminal-first algorithmic trading CLI powered by GoldRush API. Built in TypeScript with a proxy server pattern for rich terminal UI alongside Claude MCP integration.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm install
|
|
9
|
+
pnpm build
|
|
10
|
+
|
|
11
|
+
# Set up your API key
|
|
12
|
+
goldrush auth
|
|
13
|
+
|
|
14
|
+
# Check token balances
|
|
15
|
+
goldrush balances eth-mainnet 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045
|
|
16
|
+
|
|
17
|
+
# Stream new DEX pairs
|
|
18
|
+
goldrush newpairs eth-mainnet
|
|
19
|
+
|
|
20
|
+
# Launch proxy server (for MCP bridge)
|
|
21
|
+
goldrush proxy
|
|
22
|
+
|
|
23
|
+
# Configure Claude MCP integration
|
|
24
|
+
goldrush install
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Commands
|
|
28
|
+
|
|
29
|
+
| Command | Purpose |
|
|
30
|
+
| -------------------------------------- | ------------------------------------ |
|
|
31
|
+
| `goldrush` | Interactive menu |
|
|
32
|
+
| `goldrush auth` | Set up API key (OS keychain) |
|
|
33
|
+
| `goldrush balances <chain> <address>` | Token balances with rich table |
|
|
34
|
+
| `goldrush transfers <chain> <address>` | Transfer history |
|
|
35
|
+
| `goldrush newpairs <chain>` | Stream new DEX pairs |
|
|
36
|
+
| `goldrush ohlcv <chain>` | OHLCV pairs stream |
|
|
37
|
+
| `goldrush search <query>` | Token search |
|
|
38
|
+
| `goldrush traders <chain>` | Top traders |
|
|
39
|
+
| `goldrush gas <chain>` | Gas prices |
|
|
40
|
+
| `goldrush chains` | List supported chains |
|
|
41
|
+
| `goldrush watch <chain> <address>` | Watch wallet activity |
|
|
42
|
+
| `goldrush proxy` | Launch proxy server |
|
|
43
|
+
| `goldrush mcp` | MCP stdio bridge (invoked by Claude) |
|
|
44
|
+
| `goldrush install` | Configure Claude MCP integration |
|
|
45
|
+
| `goldrush config` | View/edit settings |
|
|
46
|
+
| `goldrush status` | Check connectivity |
|
|
47
|
+
| `goldrush logout` | Clear credentials |
|
|
48
|
+
|
|
49
|
+
## Architecture
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
Claude Desktop/Code <--stdio--> MCP Bridge <--HTTP--> Proxy Server <--HTTP--> Hosted MCP Server
|
|
53
|
+
(goldrush mcp) (goldrush proxy) (goldrush-mcp.vercel.app)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The proxy server fetches tool definitions and forwards tool calls to the hosted MCP server (configurable via `GOLDRUSH_MCP_URL`). The MCP bridge translates between stdio (for Claude) and HTTP (for the proxy), keeping terminal UI output separate from the MCP protocol.
|
|
57
|
+
|
|
58
|
+
## Development
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
pnpm dev # Run with tsx
|
|
62
|
+
pnpm build # Build with tsup
|
|
63
|
+
pnpm test # Run tests
|
|
64
|
+
pnpm typecheck # TypeScript check
|
|
65
|
+
```
|