@hedge-layer/cli 1.7.0 → 2.0.0

package/README.md

@@ -16,6 +16,33 @@ npm install -g @hedge-layer/cli
 
 Requires Node.js 22 or later.
 
+### Install troubleshooting
+
+- **`EACCES` / "operation was rejected by your operating system"** on `npm install -g`:
+  your npm prefix points at a root-owned directory (e.g. `/usr/lib/node_modules`) and you
+  don't have `sudo`. Install into a user-writable prefix instead:
+
+  ```bash
+  mkdir -p "$HOME/.npm-global"
+  npm config set prefix "$HOME/.npm-global"
+  export PATH="$HOME/.npm-global/bin:$PATH"   # add to your shell rc to persist
+  npm install -g @hedge-layer/cli
+  ```
+
+- **`nvm` warns `npmrc ... globalconfig and/or prefix setting ... incompatible with nvm`:**
+  this is harmless shell-init noise from `nvm` (not from `hl`) that appears after setting a
+  custom npm prefix as above — the CLI still works. To avoid it entirely under `nvm`, install
+  without a custom prefix (nvm's per-version `bin/` is already user-writable):
+
+  ```bash
+  npm config delete prefix
+  npm config delete globalconfig
+  nvm use --delete-prefix "$(node -v)" --silent
+  npm install -g @hedge-layer/cli
+  ```
+
+  Alternatively, skip the global install and run on demand with `npx @hedge-layer/cli <command>`.
+
 ## Quick Start
 
 ```bash
@@ -29,13 +56,16 @@ hl brief "US China trade war tariffs"
 # 4. Or start an interactive research session
 hl research
 
-# 5. Run the persisted liquidity-provider loop
-hl lp scan "liquidity opportunities"
-hl lp recommend --scan-id <scan-id>
-hl lp evaluate
+# 5. Run the manual liquidity-provider flow
+hl --json feed liquidity-provider --limit 15 | jq '{ markets: .markets }' > markets.json
+hl lp allocator --markets markets.json
+hl-trader buy
 
 # 6. Check linked wallet funds
 hl wallet balances
+
+# 7. Analyze a market probability edge
+hl signal analyze "https://polymarket.com/event/example-market"
 ```
 
 ## Commands
@@ -47,11 +77,24 @@ Liquidity-provider workflows are available under `hl lp`:
 
 ```bash
 hl lp scan "liquidity opportunities"   # persist candidate evidence
+hl lp allocator --markets markets.json # run allocator agent on an explicit list
 hl lp recommend --scan-id <scan-id>    # recommend allocate/reduce/exit actions
 hl lp evaluate                         # summarize PnL lessons
-hl lp run                              # run the dry-run chain
 ```
 
+The lightweight manual loop is:
+
+```bash
+hl --json feed lp-opportunity --limit 15 > markets.json
+hl lp allocator --markets markets.json
+hl-trader buy ...
+```
+
+`hl lp allocator` submits the candidate market list through the web API to the
+allocator agent. Allocator output shows target capital, quote regime, failed
+safety checks, and split spread/reward economics. Trade execution stays outside
+the `hl` allocator command.
+
 Wallet commands are available under `hl wallet`:
 
 ```bash
@@ -72,6 +115,14 @@ Keep a small `POL` balance in the owner wallet for Polygon gas; without native
 `POL`, the browser-signed transfer can fail even when the deposit wallet has
 enough `pUSD`.
 
+Signal-agent analysis is available under `hl signal`:
+
+```bash
+hl signal analyze "https://polymarket.com/event/example-market"
+hl signal analyze "https://polymarket.com/event/example-market" --context "Recent search notes"
+hl --json signal analyze "https://polymarket.com/event/example-market" | jq '.result.analysis'
+```
+
 ## Changelog
 
 See [CHANGELOG.md](CHANGELOG.md) for release history.