@baseline-markets/cli 0.2.2 → 0.3.0

package/README.md

@@ -1,6 +1,8 @@
 # Baseline CLI
 
-CLI for building and executing Baseline token launch calls.
+CLI for Baseline token launches, swaps, and positions.
+
+See [UX.md](./UX.md) for the target public command shape.
 
 ## Install
 
@@ -8,6 +10,8 @@ Run without installing:
 
 ```sh
 npx @baseline-markets/cli launch --help
+npx @baseline-markets/cli swap --help
+npx @baseline-markets/cli position --help
 ```
 
 Or install globally:
@@ -60,6 +64,86 @@ BASELINE_PRIVATE_KEY=0x...
 The deployer account is derived from the private key when `--execute` is used
 and `--account` is omitted.
 
+## Swaps
+
+Quote a swap without sending a transaction:
+
+```sh
+baseline quote swap \
+  --chain-id 84532 \
+  --token 0x... \
+  --buy \
+  --exact-out \
+  --amount 100 \
+  --format json
+```
+
+Execute a swap with quote-derived slippage limits and input-token approval:
+
+```sh
+baseline swap \
+  --chain-id 84532 \
+  --token 0x... \
+  --buy \
+  --exact-out \
+  --amount 100 \
+  --slippage-bps 100 \
+  --private-key 0x...
+```
+
+Simulate the exact swap calls without sending transactions:
+
+```sh
+baseline swap \
+  --chain-id 84532 \
+  --token 0x... \
+  --buy \
+  --amount 100 \
+  --simulate \
+  --private-key 0x...
+```
+
+`--buy --exact-in` spends an exact reserve amount for at least the quoted
+BTokens. `--buy --exact-out` buys an exact BToken amount with a maximum reserve
+input. Sell commands mirror this with BToken input or reserve output.
+`--exact-in` is the default when neither exact flag is provided.
+
+## Positions
+
+Inspect a position:
+
+```sh
+baseline position \
+  --chain-id 84532 \
+  --token 0x... \
+  --user 0x... \
+  --format json
+```
+
+The position output includes staking balances, earned rewards, credit
+collateral, debt, and current max borrow. It prints a human-readable table by
+default; pass `--format json` for structured output.
+
+Stake, unstake, borrow, repay, and claim:
+
+```sh
+baseline position stake --chain-id 84532 --token 0x... --amount 25 --private-key 0x...
+baseline position unstake --chain-id 84532 --token 0x... --amount 10 --private-key 0x...
+baseline position borrow --chain-id 84532 --token 0x... --amount 100 --private-key 0x...
+baseline position repay --chain-id 84532 --token 0x... --amount 50 --private-key 0x...
+baseline position claim --chain-id 84532 --token 0x... --private-key 0x...
+```
+
+`position stake` approves the BToken before depositing.
+`position repay` approves the reserve before repaying unless `--use-native` is
+set.
+`position borrow --output-native` receives wrapped-native reserves as native ETH
+when the reserve supports it.
+`position claim --as-native` claims wrapped-native reserve rewards as native ETH
+when the reserve supports it.
+Pass `--simulate` to any position action to simulate the exact calls without
+sending transactions.
+
 ## Launch Modes
 
 `zrp` is the default zero-reserve launch:
@@ -80,7 +164,7 @@ The pool BToken amount is derived from `--total-supply`.
 
 ## Environment
 
-- `BASELINE_PRIVATE_KEY`: signer used by `--execute`
+- `BASELINE_PRIVATE_KEY`: signer used by launch execution, swaps, and positions
 - `RPC_URL`: Base Sepolia fork source for integration tests
 
 ## Tests