@jup-ag/cli 0.1.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,47 @@
1
+ # Jupiter CLI
2
+
3
+ CLI for interacting with Jupiter's products on Solana: Spot, Perps, Lend, Prediction Markets and more.
4
+
5
+ ## Install
6
+
7
+ Install via npm:
8
+
9
+ ```bash
10
+ npm i -g @jup-ag/cli
11
+ ```
12
+
13
+ Or use the install script to auto-detect the best method:
14
+
15
+ ```bash
16
+ curl -fsSL https://raw.githubusercontent.com/jup-ag/cli/main/scripts/install.sh | bash
17
+ ```
18
+
19
+ ## Quick start
20
+
21
+ ```bash
22
+ # Generate a new key called 'default'
23
+ jup keys add default
24
+
25
+ # Or import an existing Solana CLI keypair
26
+ jup keys solana-import
27
+
28
+ # Get a swap quote
29
+ jup spot quote --from SOL --to USDC --amount 1
30
+
31
+ # Execute a swap
32
+ jup spot swap --from SOL --to USDC --amount 1
33
+
34
+ # Check your portfolio
35
+ jup spot portfolio
36
+ ```
37
+
38
+ ## Docs
39
+
40
+ See the [`/docs`](./docs/) directory for specific guides and workflows:
41
+
42
+ - [Setup](docs/setup.md): Installation of the CLI
43
+ - [Config](docs/config.md): CLI settings and configurations
44
+ - [Keys](docs/keys.md): Private key management
45
+ - [Spot](docs/spot.md): Swaps, transfers, token and portfolio data
46
+
47
+ > This CLI is designed to be LLM friendly and all commands are non-interactive. Set JSON output mode for structured responses: `jup config set --output json`.