@jup-ag/cli 0.1.0

package/docs/config.md

@@ -0,0 +1,22 @@
+# Config
+
+Settings are stored at `~/.config/jup/settings.json`.
+
+## View current settings
+
+```bash
+jup config list
+```
+
+## Set output format
+
+```bash
+jup config set --output json
+jup config set --output table
+```
+
+## Set active key
+
+```bash
+jup config set --active-key <name>
+```

package/docs/keys.md

@@ -0,0 +1,64 @@
+# Keys
+
+A key is required for signing transactions (swaps, transfers). Keys are stored locally at `~/.config/jup/keys/`.
+
+## Generate a new key
+
+```bash
+jup keys add <name>
+```
+
+## Import a Solana CLI keypair
+
+```bash
+jup keys solana-import
+jup keys solana-import --name mykey --path ~/.config/solana/id.json
+```
+
+## Recover from seed phrase or private key
+
+```bash
+jup keys add <name> --recover --seed-phrase "word1 word2 ..."
+jup keys add <name> --recover --private-key <key>
+```
+
+`--private-key` accepts hex, base58, base64, or a JSON byte array.
+
+## List keys
+
+```bash
+jup keys list
+```
+
+```js
+// Example JSON response:
+[
+  {
+    "name": "default",
+    "address": "ABC1...xyz", // Solana wallet address
+    "active": true // if true, key is used by default for signing transactions
+  }
+]
+```
+
+## Set the active key
+
+```bash
+jup keys use <name>
+```
+
+## Edit a key
+
+```bash
+jup keys edit <name> --name <new-name>
+jup keys edit <name> --seed-phrase "word1 word2 ..."
+jup keys edit <name> --private-key <key>
+```
+
+Rename a key and/or replace its credentials. Options can be combined. `--seed-phrase` and `--private-key` are mutually exclusive.
+
+## Delete a key
+
+```bash
+jup keys delete <name>
+```

package/docs/setup.md

@@ -0,0 +1,41 @@
+# Setup
+
+## Install
+
+### Option 1: npm (recommended if npm is available)
+
+```bash
+npm i -g @jup-ag/cli
+```
+
+### Option 2: Install script
+
+Auto-detects the best install method (volta > npm > standalone binary):
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/jup-ag/cli/main/scripts/install.sh | bash
+```
+
+### Option 3: Standalone binary
+
+Download the latest binary from GitHub releases:
+
+```bash
+curl -fsSL https://github.com/jup-ag/cli/releases/latest/download/jup-linux-x64 -o jup
+chmod +x jup
+sudo mv jup /usr/local/bin/
+```
+
+Replace `jup-linux-x64` with the appropriate binary for your platform (`jup-darwin-arm64`, `jup-darwin-x64`, etc.).
+
+### Option 4: Build from source
+
+Requires [Bun](https://bun.sh).
+
+```bash
+git clone https://github.com/jup-ag/cli.git
+cd cli
+bun install
+bun build src/index.ts --compile --outfile jup
+sudo mv jup /usr/local/bin/
+```

package/docs/spot.md

@@ -0,0 +1,151 @@
+# Spot Trading
+
+Requires: an active key for swap and transfer commands. See [setup](setup.md).
+
+## Token resolution
+
+Anywhere a token is specified (`--from`, `--to`, `--token`, `--search`), you can use either:
+
+- **Symbol** (e.g. `SOL`, `USDC`, `JUP`) — the CLI auto-resolves to the best-matching token
+- **Mint address** (e.g. `So11111111111111111111111111111111111111112`) — exact match
+
+When using a symbol, the CLI picks the top result from Jupiter's token search. Use a mint address when you need to target a specific token (e.g. to disambiguate tokens with the same symbol).
+
+## Commands
+
+### Search tokens
+
+```bash
+jup spot tokens --search <query>
+jup spot tokens --search <query> --limit 5
+jup spot tokens --search <mint-address>
+jup spot tokens --search "<mint1>,<mint2>"
+```
+
+### Get a swap quote
+
+```bash
+jup spot quote --from SOL --to USDC --amount 1
+jup spot quote --from <mint> --to <mint> --raw-amount 1000000000
+```
+
+- `--amount` uses human-readable units (e.g. `1` SOL = 1 SOL)
+- `--raw-amount` uses on-chain units (e.g. `1000000000` lamports = 1 SOL)
+- Exactly one of `--amount` or `--raw-amount` is required
+
+```js
+// Example JSON response:
+{
+  "inputToken": { "id": "So11...1112", "symbol": "SOL", "decimals": 9 },
+  "outputToken": { "id": "EPjF...USDC", "symbol": "USDC", "decimals": 6 },
+  "inAmount": "1", // human-readable decimal amount
+  "outAmount": "84.994059", // human-readable decimal amount
+  "inUsdValue": 84.98, // USD value
+  "outUsdValue": 84.99,
+  "priceImpact": 0.005 // max value of 1; 0.005 means 0.5%
+}
+```
+
+### Execute a swap
+
+```bash
+jup spot swap --from SOL --to USDC --amount 1
+jup spot swap --from SOL --to USDC --amount 1 --key mykey
+```
+
+- `--key` overrides the active key for this transaction
+
+```js
+// Example JSON response:
+{
+  "trader": "ABC1...xyz", // trader address
+  "signature": "3dV98zG...", // tx signature viewable on an explorer
+  "inputToken": { "id": "So11...1112", "symbol": "SOL", "decimals": 9 },
+  "outputToken": { "id": "EPjF...USDC", "symbol": "USDC", "decimals": 6 },
+  "inAmount": "1", // human-readable decimal amount
+  "outAmount": "84.95", // human-readable decimal amount
+  "inUsdValue": 84.98,
+  "outUsdValue": 84.95,
+  "priceImpact": 0.005, // max value of 1; 0.005 means 0.5%
+  "networkFeeLamports": 5000 // divide by 10^9 for SOL fee
+}
+```
+
+### View portfolio
+
+```bash
+jup spot portfolio
+jup spot portfolio --key mykey
+jup spot portfolio --address <wallet-address>
+```
+
+- With no options, uses the active key's wallet
+- `--address` looks up any wallet without needing a key
+
+```js
+// Example JSON response:
+{
+  "totalValue": 1250.50, // total USD net worth
+  "tokens": [
+    {
+      "id": "So11...1112", // mint address
+      "symbol": "SOL",
+      "decimals": 9,
+      "amount": 10.5, // human-readable decimal balance
+      "rawAmount": "10500000000", // on-chain integer balance
+      "value": 892.50, // USD value of holdings
+      "price": 85.00, // current token USD price
+      "priceChange": 0.032, // 24h price change; 0.032 means 3.2%
+      "isVerified": true
+    }
+  ]
+}
+```
+
+### Transfer tokens
+
+```bash
+jup spot transfer --token SOL --to <recipient-address> --amount 1
+jup spot transfer --token USDC --to <recipient-address> --amount 50
+jup spot transfer --token <mint> --to <recipient-address> --raw-amount 1000000000
+jup spot transfer --token SOL --to <recipient-address> --amount 1 --key mykey
+```
+
+- Works with both SOL and any SPL token
+- `--token` accepts a symbol or mint address
+
+```js
+// Example JSON response:
+{
+  "sender": "ABC1...xyz", // sender address
+  "recipient": "DEF2...abc",
+  "token": { "id": "EPjF...USDC", "symbol": "USDC", "decimals": 6 },
+  "amount": "50", // human-readable decimal amount
+  "value": 50.00, // USD value of transfer
+  "networkFeeLamports": 5000, // divide by 10^9 for SOL fee
+  "signature": "4xK29zH..." // tx signature viewable on an explorer
+}
+```
+
+## Workflows
+
+### Check price then swap
+
+```bash
+jup spot quote --from SOL --to USDC --amount 1
+# Review the quoted output and price impact
+jup spot swap --from SOL --to USDC --amount 1
+```
+
+### Look up a token by mint address
+
+```bash
+jup spot tokens --search <mint-address>
+```
+
+### Check holdings then transfer
+
+```bash
+jup spot portfolio
+jup spot transfer --token USDC --to <recipient-address> --amount 50
+```

package/llms.txt

@@ -0,0 +1,17 @@
+# Jupiter CLI (`jup`)
+
+CLI for interacting with Jupiter's products on Solana: Spot, Perps, Lend, Prediction Markets and more.
+
+## Error handling
+
+On failure, commands exit with non-zero code with an error message. In JSON mode (`--format json`), errors are returned as `{ "error": "<message>" }`.
+
+## Skills
+
+- [Setup](docs/setup.md): Installation of the CLI
+- [Config](docs/config.md): CLI settings and configurations
+- [Keys](docs/keys.md): Private key management
+- [Spot](docs/spot.md): Swaps, transfers, token and portfolio data
+- Perps: Perpetual futures (coming soon)
+- Lend: Lending and borrowing (coming soon)
+- Predictions: Create and trade prediction markets (coming soon)

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@jup-ag/cli",
+  "version": "0.1.0",
+  "license": "GPL-3.0",
+  "type": "module",
+  "bin": {
+    "jup": "dist/index.js"
+  },
+  "files": [
+    "dist/index.js",
+    "docs",
+    "llms.txt",
+    "README.md"
+  ],
+  "scripts": {
+    "dev": "bun run src/index.ts",
+    "build": "bun build src/index.ts --outdir dist --target node --format esm --minify",
+    "build:binary": "bash scripts/build.sh",
+    "typecheck": "bunx tsc --noEmit",
+    "lint": "bunx oxlint src",
+    "test": "bun test",
+    "ci": "bun run lint && bun run typecheck && bun run test",
+    "prepublishOnly": "bun run build"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "oxlint": "^1.53.0",
+    "prettier": "^3.8.1"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@scure/bip32": "^2.0.1",
+    "@scure/bip39": "^2.0.1",
+    "@solana-program/token": "^0.12.0",
+    "@solana/kit": "^6.2.0",
+    "chalk": "^5.6.2",
+    "cli-table3": "^0.6.5",
+    "commander": "^14.0.3",
+    "ky": "^1.14.3"
+  }
+}