hufi-cli 0.5.5 → 0.6.1

package/README.md

@@ -1,82 +1,146 @@
 # hufi-cli
 
-CLI tool for the hu.fi DeFi platform.
+CLI tool for the [hu.fi](https://hu.finance) DeFi platform.
 
 ## Install
 
 ```bash
-bun install
+bun install -g hufi-cli
 ```
 
-## Usage
+Or run without installing:
 
 ```bash
-# Show help
-bunx hufi-cli --help
+bunx hufi-cli <command>
+```
+
+All examples below assume global install. Otherwise replace `hufi` with `bunx hufi-cli`.
 
-# Generate a new wallet (key saved to ~/.hufi-cli/key.json)
-bunx hufi-cli auth generate
+## Quick Start
 
-# Authenticate (uses saved key by default)
-bunx hufi-cli auth login
+```bash
+# Generate a wallet
+hufi auth generate
 
-# Check auth status
-bunx hufi-cli auth status
+# Login with saved key
+hufi auth login
 
-# Register exchange API key
-bunx hufi-cli exchange register --name mexc --api-key xxx --secret-key yyy
+# Browse campaigns
+hufi campaign list
+```
 
-# List exchange API keys
-bunx hufi-cli exchange list
+## Commands
 
-# Check campaign join status
-bunx hufi-cli campaign status --chain-id 137 --address 0x...
+### auth
 
-# Join a campaign
-bunx hufi-cli campaign join --chain-id 137 --address 0x...
+| Command | Description |
+|---------|-------------|
+| `auth generate` | Generate a new EVM wallet (saves to `~/.hufi-cli/key.json`) |
+| `auth login` | Authenticate with Recording Oracle (uses saved key by default) |
+| `auth status` | Show current auth status |
 
-# List joined campaigns
-bunx hufi-cli campaign list --limit 20
+```bash
+hufi auth generate --json
+hufi auth login --private-key <key>
+hufi auth status
 ```
 
-## Global Options
+### campaign
 
-- `--json` - Output as JSON (available on all commands)
+| Command | Description |
+|---------|-------------|
+| `campaign list` | Browse available campaigns |
+| `campaign get` | Get details for a specific campaign |
+| `campaign joined` | List campaigns you've joined |
+| `campaign join` | Join a campaign |
+| `campaign status` | Check join status |
+| `campaign progress` | Check your progress |
+| `campaign leaderboard` | View campaign leaderboard |
 
-## Configuration
+```bash
+hufi campaign list                                          # list active campaigns
+hufi campaign list --status completed --chain-id 1          # completed on Ethereum
+hufi campaign get --chain-id 137 --address 0x...            # campaign details
+hufi campaign join --address 0x...                          # join (chain-id defaults to 137)
+hufi campaign status --address 0x...                        # check status
+hufi campaign progress --address 0x...                      # your progress
+hufi campaign leaderboard --address 0x...                   # leaderboard
+```
 
-Configuration is stored at `~/.hufi-cli/config.json`.
+Running `campaign status/join/progress/leaderboard` without `-a` shows help.
 
-## Capabilities
+### exchange
 
-### What This CLI Can Do
+| Command | Description |
+|---------|-------------|
+| `exchange register` | Register a read-only exchange API key |
+| `exchange list` | List registered API keys |
 
-| Module | Commands | Description |
-|--------|----------|-------------|
-| **auth** | login, generate, status | Authentication & wallet management |
-| **exchange** | register, list | Exchange API key management |
-| **campaign** | list, get, joined, join, status, progress, leaderboard | Campaign browsing, joining, and monitoring |
+```bash
+hufi exchange register --name mexc --api-key <key> --secret-key <secret>
+hufi exchange list
+```
 
-### What This CLI Cannot Do
+### staking
 
-- ❌ Execute on-chain transactions
-- ❌ Configure trading strategies
-- ❌ Multi-signature or voting operations
+| Command | Description |
+|---------|-------------|
+| `staking status` | Check HMT staking status |
+| `staking deposit` | Show deposit address and QR code |
+| `staking stake` | Stake HMT tokens |
+| `staking unstake` | Initiate unstaking (tokens locked for lock period) |
+| `staking withdraw` | Withdraw unlocked tokens after lock period |
 
-## API Endpoints
+```bash
+hufi staking deposit                                   # show address QR code
+hufi staking status                                    # check your staking
+hufi staking status --address 0x...                    # check another address
+hufi staking stake -a 1000                             # stake 1000 HMT
+hufi staking unstake -a 500                            # unstake 500 HMT
+hufi staking withdraw                                  # withdraw unlocked tokens
+```
+
+Supports Polygon (chain 137) and Ethereum (chain 1). Staking contract: `0x01D1...07F1D` on Polygon.
+
+## Global Options
 
-- Recording Oracle: `https://ro.hu.finance`
-- Campaign Launcher: `https://cl.hu.finance`
+| Option | Description |
+|--------|-------------|
+| `--config-file <path>` | Custom config file (default: `~/.hufi-cli/config.json`) |
+| `--key-file <path>` | Custom key file (default: `~/.hufi-cli/key.json`) |
+| `-V, --version` | Show version |
+| `-h, --help` | Show help |
+
+All commands support `--json` for machine-readable output.
+
+## Configuration
+
+Stored at `~/.hufi-cli/config.json`:
+
+```json
+{
+  "recordingApiUrl": "https://ro.hu.finance",
+  "launcherApiUrl": "https://cl.hu.finance",
+  "defaultChainId": 137,
+  "address": "0x...",
+  "accessToken": "..."
+}
+```
 
 ## Development
 
 ```bash
-# Run directly
-bunx hufi-cli --help
+bun install              # install deps
+bun run dev -- --help    # run from source
+bun run build            # build to dist/cli.js
+bun test                 # unit tests
+bun run test:cli         # integration tests
+bun run typecheck        # type check
+```
 
-# Run tests
-bun test
+## API Endpoints
 
-# Type check
-bun run typecheck
-```
+| Service | URL |
+|---------|-----|
+| Recording Oracle | https://ro.hu.finance |
+| Campaign Launcher | https://cl.hu.finance |