@bankr/cli 0.3.37 → 0.3.43

package/README.md

@@ -1,195 +1,90 @@
 # @bankr/cli
 
-Official CLI for the [Bankr](https://bankr.bot) AI agent platform. Interact with the Bankr AI agent directly from your terminal.
+Official CLI for the [Bankr](https://bankr.bot) AI agent platform. Prompt the Bankr agent, manage your wallet, launch tokens and claim their fees, and use the Bankr LLM gateway from your terminal.
 
-## Installation
-
-```bash
-npm install -g @bankr/cli
-```
+The full command reference is at [docs.bankr.bot/cli](https://docs.bankr.bot/cli), and every command takes `--help`.
 
-## Quick Start
-
-A [Bankr Club subscription](https://bankr.bot) or LLM credits (Max Mode) is required to use the agent. There is no free tier.
+## Installation
 
 ```bash
-# Authenticate with your API key
-bankr login
+npm install -g @bankr/cli    # or: bun install -g @bankr/cli
 
-# Send a prompt
-bankr agent "what's trending on base?"
-
-# Or use the shorthand (no subcommand)
-bankr "what is the price of ETH?"
+# Later: update with whichever package manager installed it
+bankr update
 ```
 
-## Commands
-
-### Authentication
+## Log in
 
 ```bash
-# Log in (interactive menu)
+# Interactive: sign in with email, open bankr.bot to create a key, or paste one
 bankr login
 
-# Log in with email (interactive — prompts for OTP and key options)
-bankr login email
+# Headless email login, for scripts and agents
+bankr login email you@example.com                  # step 1: send a one-time code
+bankr login email you@example.com --code 123456    # step 2: verify and create an API key (new accounts get a wallet)
 
-# Log in with email (headless two-step, for scripts and agents):
-bankr login email user@example.com                  # Step 1: send OTP
-bankr login email user@example.com --code 123456 \  # Step 2: verify + complete
-  --accept-terms --key-name "My Key" --read-write --llm
-
-# Log in directly with an API key (non-interactive)
+# An existing bk_... key from bankr.bot/api-keys (checked against the API before it's saved)
 bankr login --api-key bk_YOUR_KEY
 
-# Log in with a separate LLM gateway key
-bankr login --api-key bk_YOUR_KEY --llm-key YOUR_LLM_KEY
-
-# Print the dashboard URL without opening a browser (non-interactive)
-bankr login --url
-
-# Log in with a custom API URL
-bankr login --api-url https://api.bankr.bot
+# Sign-In with Ethereum, for headless agents
+bankr login siwe --private-key 0xYOUR_PRIVATE_KEY
 
-# Show current auth info and validate connection
+# Show the key in use, check the connection, and list your account details
 bankr whoami
-
-# Clear stored credentials
-bankr logout
-```
-
-### Prompts
-
-```bash
-# Send a prompt and wait for the response
-bankr agent "swap 10 USDC to ETH on base"
-
-# Shorthand — just pass the prompt directly
-bankr "what are the top holders of VIRTUAL?"
-
-# Continue the most recent conversation
-bankr agent --continue "and what about SOL?"
-bankr agent -c "compare them"
-
-# Continue a specific thread
-bankr agent --thread thr_ABC123 "tell me more"
-
-# Max Mode: pick the model. Only the two newest releases of each line, and
-# only frontier / flagship / balanced lines, are accepted (the same set the
-# web picker shows); anything else is rejected and the error lists every
-# valid id.
-bankr agent --model claude-opus-5 "audit this contract"
 ```
 
-### Token Launch
-
-```bash
-# Interactive wizard — guides you through name, image, tweet, and fee recipient
-bankr launch
-
-# Non-interactive with all options
-bankr launch --name "TESTCOIN" --image "https://example.com/img.png" \
-  --tweet "https://x.com/user/status/123" --fee "@vitalik" --fee-type x -y
+- Completing a headless email login (`--code` or `--ni`) or a SIWE login accepts the [Terms of Service](https://bankr.bot/terms).
+- Email-login keys get Wallet, Agent and Token Launch API access and can transact. Opt out with `--no-wallet-api`, `--no-agent-api`, `--no-token-launch` or `--read-only`, and add LLM gateway access with `--llm`. SIWE keys are read-only unless you pass `--read-write`.
+- On an account with passkey MFA, email login prints a bankr.bot approval link (valid for five minutes) and continues once you approve it with your passkey.
 
-# Quick launch (name only, skip confirmation)
-bankr launch --name "TESTCOIN" -y
+## Prompt the agent
 
-# Pair the pool with a tokenized stock or another listed quote token instead of WETH (Robinhood Chain or Base)
-bankr launch quotes --chain robinhood        # list the quote tokens you can pair with
-bankr launch --name "TESTCOIN" --chain robinhood --quote TSLA -y
-bankr launch --name "TESTCOIN" --chain robinhood --quote musebook -y
-bankr launch --name "TESTCOIN" --chain robinhood --quote BNKR -y      # the Robinhood Chain BNKR contract
-
-# Fee recipient types: x, farcaster, ens, wallet
-bankr launch --name "TESTCOIN" --fee "vitalik.eth" --fee-type ens -y
-bankr launch --name "TESTCOIN" --fee "0x1234..." --fee-type wallet -y
-```
-
-### Job Management
+Prompting the agent from the CLI needs a Bankr Club membership or LLM credits for Max Mode — see [Access](https://docs.bankr.bot/agent/access).
 
 ```bash
-# Check the status of a job
-bankr agent status job_ABC123DEF456
-
-# Cancel a running job
+bankr "what is the price of ETH?"                          # shorthand for bankr agent
+bankr agent "swap 10 USDC to ETH on base"
+bankr agent --continue "and what about SOL?"               # continue the last thread (-c)
+bankr agent --thread thr_ABC123 "tell me more"
+bankr agent --model claude-opus-5 "audit this contract"    # Max Mode, billed to LLM credits
+echo 'buy $50 of ETH on base' | bankr agent prompt         # piped prompt; single quotes keep $50 intact
+bankr agent status job_ABC123DEF456 --wait                 # follow a job until it finishes
 bankr agent cancel job_ABC123DEF456
 ```
 
-### LLM Gateway
-
-Launch Claude Code / OpenCode routed through the Bankr gateway:
-
-```bash
-# Claude Code — `bankr claude` is a top-level alias for `bankr llm claude`
-# (auto-translates dotted model IDs to the Anthropic wire format)
-bankr claude --model claude-opus-5
-
-# Or use dotted form — bankr claude rewrites it to claude-opus-4-8
-bankr claude --model claude-opus-4.8
-
-# The [1m] suffix is optional via the gateway, but MUST be quoted if used
-# (zsh reads [1m] as a glob)
-bankr claude --model "claude-opus-5[1m]"
+The agent's progress lines print on stderr while it works, so they stay out of piped output.
 
-# OpenCode (use the bankr/ prefix with the gateway-canonical dotted form)
-bankr llm opencode -m bankr/claude-opus-4.8
-```
-
-Because `claude` is a command, it shadows the default prompt fallthrough:
-`bankr claude ...` launches Claude Code rather than prompting the agent. Use
-`bankr agent "..."` to send the agent a prompt starting with that word.
-
-**Claude Code model format**: Claude Code's `--model` flag expects Anthropic
-wire IDs, which use dashes rather than dots in the version (`claude-opus-5`,
-`claude-sonnet-5`, `claude-opus-4-8`, `claude-haiku-4-5`). If you pass the
-gateway-canonical dotted form (`claude-opus-4.8`), Claude Code silently falls
-back to its default — the flag appears honored but the real request is a
-different model.
-
-`bankr claude` translates dotted → dashed for you. If you use older
-versions of the CLI (or invoke `claude` directly via `ANTHROPIC_BASE_URL`),
-pass the dashed form explicitly.
-
-**1M context tier**: the gateway strips Claude Code's `[1m]` suffix and enables
-the 1M beta from the model's own context window, so it's **optional here** —
-`claude-opus-5` and `claude-opus-5[1m]` send an identical upstream request. If
-you do use it, **quote it**: in zsh (the macOS default) `[1m]` is a glob
-character class, so an unquoted id aborts with `zsh: no matches found:
-claude-opus-5[1m]` before the CLI ever runs. Bash passes it through literally,
-so the same command can work on one machine and fail on another.
-
-### Configuration
-
-```bash
-# View all config
-bankr config get
+## Commands
 
-# Get a specific value
-bankr config get apiUrl
+| Command                                                        | What it does                                                                                                          |
+| -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `bankr wallet`                                                 | Portfolio, transfer, swap, sign and submit, without the agent                                                         |
+| `bankr tokens`                                                 | Token search and info                                                                                                 |
+| `bankr launch`                                                 | Launch a token on Base, Robinhood Chain or Arbitrum; `bankr launch quotes` lists the tokens a launch can pair with    |
+| `bankr fees`                                                   | Creator-fee dashboard and claims, including `fees claim-wallet` with your own private key                             |
+| `bankr llm`, `bankr claude`                                    | LLM gateway: models, credits and auto top-up, coding-tool config, and Claude Code or OpenCode run through the gateway |
+| `bankr project`                                                | Your project page                                                                                                     |
+| `bankr club`                                                   | Bankr Club status, sign-up and cancellation                                                                           |
+| `bankr files`                                                  | Your wallet's file storage                                                                                            |
+| `bankr x402`, `bankr webhooks`                                 | Deploy and manage paid x402 endpoints and webhooks that trigger the agent                                             |
+| `bankr config`, `bankr sounds`, `bankr update`, `bankr logout` | Settings and maintenance                                                                                              |
 
-# Set a value
-bankr config set apiUrl https://api.bankr.bot
+Add `--ni` (or set `BANKR_NOT_INTERACTIVE=1`) to any command to skip confirmations and fail fast instead of prompting.
 
-# Set a separate LLM gateway key
-bankr config set llmKey YOUR_LLM_KEY
-```
+The package also exports its API client (`submitPrompt`, `pollJob`, `getUserInfo`, `getBalances` and more) for Node.js — see [Programmatic usage](https://docs.bankr.bot/cli#programmatic-usage).
 
 ## Configuration
 
-Credentials are stored in `~/.bankr/config.json`.
-
-Environment variables override stored values:
-
-| Variable        | Description                                                |
-| --------------- | ---------------------------------------------------------- |
-| `BANKR_API_KEY` | API key (overrides stored key)                             |
-| `BANKR_API_URL` | API URL (default: `https://api.bankr.bot`)                 |
-| `BANKR_LLM_KEY` | LLM gateway key (falls back to `BANKR_API_KEY` if not set) |
-| `BANKR_LLM_URL` | LLM gateway URL (default: `https://llm.bankr.bot`)         |
+Credentials are stored in `~/.bankr/config.json`; use `--config <path>` or `BANKR_CONFIG` for another file. Environment variables override stored values:
 
-## API Key
+| Variable        | Description                                            |
+| --------------- | ------------------------------------------------------ |
+| `BANKR_API_KEY` | API key                                                |
+| `BANKR_LLM_KEY` | LLM gateway key (falls back to the API key if not set) |
+| `BANKR_API_URL` | API URL (default: `https://api.bankr.bot`)             |
+| `BANKR_LLM_URL` | LLM gateway URL (default: `https://llm.bankr.bot`)     |
 
-Generate an API key at [bankr.bot/api-keys](https://bankr.bot/api-keys). Keys start with `bk_` and require Agent API access to be enabled.
+Read and set stored values with `bankr config get|set apiKey|apiUrl|llmKey|llmUrl`.
 
 ## License