-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcli.html
More file actions
496 lines (448 loc) · 23.2 KB
/
cli.html
File metadata and controls
496 lines (448 loc) · 23.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>CLI Reference | Fixer Protocol Docs</title>
<meta name="description" content="Complete reference for the Fixer Protocol CLI: auth, wallet, policies, transactions, and pay commands.">
<link rel="icon" type="image/png" href="assets/logo-black.png">
<link rel="stylesheet" href="assets/style.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/themes/prism-tomorrow.min.css">
</head>
<body>
<div class="sidebar-overlay"></div>
<header class="header">
<button class="menu-toggle" aria-label="Open menu">☰</button>
<a href="index.html" class="header-logo">
<img src="assets/logo-black.png" alt="Fixer Protocol" class="header-logo-img">
<span class="header-logo-badge">Docs</span>
</a>
<div class="header-divider"></div>
<nav class="header-nav">
<a href="index.html">Introduction</a>
<a href="quickstart.html">Quickstart</a>
<a href="guides.html">Guides</a>
<a href="sdk.html">SDK</a>
<a href="api.html">API Reference</a>
<a href="concepts.html">Concepts</a>
</nav>
<div class="header-actions">
<a href="https://github.com/fixerprotocol" class="btn-ghost" target="_blank" rel="noopener">
<svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M12 2C6.477 2 2 6.484 2 12.017c0 4.425 2.865 8.18 6.839 9.504.5.092.682-.217.682-.483 0-.237-.008-.868-.013-1.703-2.782.605-3.369-1.343-3.369-1.343-.454-1.158-1.11-1.466-1.11-1.466-.908-.62.069-.608.069-.608 1.003.07 1.531 1.032 1.531 1.032.892 1.53 2.341 1.088 2.91.832.092-.647.35-1.088.636-1.338-2.22-.253-4.555-1.113-4.555-4.951 0-1.093.39-1.988 1.029-2.688-.103-.253-.446-1.272.098-2.65 0 0 .84-.27 2.75 1.026A9.564 9.564 0 0112 6.844c.85.004 1.705.115 2.504.337 1.909-1.296 2.747-1.027 2.747-1.027.546 1.379.202 2.398.1 2.651.64.7 1.028 1.595 1.028 2.688 0 3.848-2.339 4.695-4.566 4.943.359.309.678.92.678 1.855 0 1.338-.012 2.419-.012 2.747 0 .268.18.58.688.482A10.019 10.019 0 0022 12.017C22 6.484 17.522 2 12 2z"/></svg>
GitHub
</a>
<a href="https://fixerprotocol.org" class="btn-primary" target="_blank" rel="noopener">fixerprotocol.org →</a>
</div>
</header>
<div class="layout">
<aside class="sidebar">
<div class="sidebar-section">
<p class="sidebar-section-title">Introduction</p>
<a href="index.html" class="sidebar-item">Overview</a>
</div>
<div class="sidebar-section">
<p class="sidebar-section-title">Getting Started</p>
<a href="quickstart.html" class="sidebar-item">Quickstart</a>
</div>
<div class="sidebar-section">
<p class="sidebar-section-title">Guides</p>
<a href="guides.html" class="sidebar-item">Overview</a>
<a href="guides.html#research-agent" class="sidebar-item sidebar-item-sub">Research Agent</a>
<a href="guides.html#multi-agent-guide" class="sidebar-item sidebar-item-sub">Multi-Agent</a>
<a href="guides.html#zk-privacy-guide" class="sidebar-item sidebar-item-sub">ZK Privacy</a>
<a href="guides.html#error-handling" class="sidebar-item sidebar-item-sub">Error Handling</a>
<a href="guides.html#production" class="sidebar-item sidebar-item-sub">Production Checklist</a>
</div>
<div class="sidebar-section">
<p class="sidebar-section-title">SDK Reference</p>
<a href="sdk.html" class="sidebar-item">Overview</a>
<a href="sdk.html#typescript" class="sidebar-item sidebar-item-sub">TypeScript SDK</a>
<a href="sdk.html#python" class="sidebar-item sidebar-item-sub">Python SDK</a>
</div>
<div class="sidebar-section">
<p class="sidebar-section-title">CLI</p>
<a href="cli.html" class="sidebar-item active">CLI Reference</a>
<a href="cli.html#auth" class="sidebar-item sidebar-item-sub">auth</a>
<a href="cli.html#wallet-cli" class="sidebar-item sidebar-item-sub">wallet</a>
<a href="cli.html#policies-cli" class="sidebar-item sidebar-item-sub">policies</a>
<a href="cli.html#transactions-cli" class="sidebar-item sidebar-item-sub">transactions</a>
<a href="cli.html#pay-cli" class="sidebar-item sidebar-item-sub">pay</a>
</div>
<div class="sidebar-section">
<p class="sidebar-section-title">API Reference</p>
<a href="api.html" class="sidebar-item">Overview</a>
<a href="api.html#authentication" class="sidebar-item sidebar-item-sub">Authentication</a>
<a href="api.html#payments" class="sidebar-item sidebar-item-sub">Payments</a>
<a href="api.html#wallet-api" class="sidebar-item sidebar-item-sub">Wallet</a>
<a href="api.html#transactions-api" class="sidebar-item sidebar-item-sub">Transactions</a>
<a href="api.html#policies-api" class="sidebar-item sidebar-item-sub">Policies</a>
<a href="api.html#privacy-api" class="sidebar-item sidebar-item-sub">ZK Privacy</a>
</div>
<div class="sidebar-section">
<p class="sidebar-section-title">Core Concepts</p>
<a href="concepts.html" class="sidebar-item">Overview</a>
<a href="concepts.html#protocol-detection" class="sidebar-item sidebar-item-sub">Protocol Detection</a>
<a href="concepts.html#solana" class="sidebar-item sidebar-item-sub">Solana Settlement</a>
<a href="concepts.html#zk-privacy" class="sidebar-item sidebar-item-sub">ZK Privacy</a>
<a href="concepts.html#spend-policies" class="sidebar-item sidebar-item-sub">Spend Policies</a>
<a href="concepts.html#multi-agent" class="sidebar-item sidebar-item-sub">Multi-Agent Payments</a>
</div>
<div class="sidebar-section">
<p class="sidebar-section-title">Reference</p>
<a href="webhooks.html" class="sidebar-item">Webhooks</a>
<a href="security.html" class="sidebar-item">Security</a>
</div>
</aside>
<main class="main">
<div class="content">
<div class="breadcrumb">
<a href="index.html">Docs</a>
<span class="breadcrumb-sep">/</span>
<span>CLI Reference</span>
</div>
<div class="page-eyebrow">CLI</div>
<h1 class="page-title">CLI Reference</h1>
<p class="page-subtitle">The <code>rail</code> CLI lets you manage wallets, policies, and transactions from the terminal, useful for scripts, CI pipelines, and one-off operations.</p>
<div class="callout callout-info">
<span class="callout-icon">ℹ️</span>
<div class="callout-body">
The CLI ships as <strong>Phase 2</strong> (Q4 2026). This page documents the planned interface. Commands and flags may change before release.
</div>
</div>
<!-- Installation -->
<h2 id="installation">Installation</h2>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">npm install -g @fixerprotocol/cli
# or
bun add -g @fixerprotocol/cli</code></pre>
</div>
<p>Verify the installation:</p>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail --version
# Fixer Protocol CLI v0.2.0</code></pre>
</div>
<h3>Global flags</h3>
<p>These flags are available on every command:</p>
<div class="param-list">
<div class="param-item">
<div class="param-meta"><div class="param-name">--agent</div><div class="param-type">string</div></div>
<div class="param-desc">Agent ID to use. Overrides <code>FIXER_AGENT_ID</code> env var.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--api-key</div><div class="param-type">string</div></div>
<div class="param-desc">API key. Overrides <code>FIXER_API_KEY</code> env var and saved credentials.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--json</div><div class="param-type">flag</div></div>
<div class="param-desc">Output raw JSON instead of formatted text. Useful for piping to <code>jq</code>.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--quiet, -q</div><div class="param-type">flag</div></div>
<div class="param-desc">Suppress all output except errors. Exit code indicates success/failure.</div>
</div>
</div>
<!-- Auth -->
<h2 id="auth">rail auth</h2>
<p>Manage authentication credentials. Credentials are stored in <code>~/.config/rail/credentials.json</code>.</p>
<h3>rail auth login</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail auth login</code></pre>
</div>
<p>Prompts for your API key interactively. Saves it to the credentials file. Use <code>--api-key</code> to pass it non-interactively:</p>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash"># Non-interactive (useful in CI)
rail auth login --api-key "$FIXER_API_KEY" --agent "my-agent"</code></pre>
</div>
<h3>rail auth logout</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail auth logout</code></pre>
</div>
<p>Removes saved credentials from disk. Does not invalidate the API key itself, do that from the dashboard.</p>
<h3>rail auth status</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail auth status
# Authenticated as: my-agent (fxp_live_xxxx...xxxx)
# Gateway: https://api.fixerprotocol.org</code></pre>
</div>
<!-- Wallet -->
<h2 id="wallet-cli">rail wallet</h2>
<h3>rail wallet balance</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail wallet balance
# Balance: 42.50 USDC
rail wallet balance --json
# {"usdc": 42.50}</code></pre>
</div>
<h3>rail wallet address</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail wallet address
# 7xKXtg2eH9sZ7pWbRqTJ3mQfJLxxxxxxxxxxxxxx
# Copy to clipboard (macOS)
rail wallet address | pbcopy</code></pre>
</div>
<h3>rail wallet fund</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail wallet fund --usdc 50
# With idempotency key (safe to re-run in scripts)
rail wallet fund --usdc 50 --idempotency-key "top-up-$(date +%Y%m%d)"</code></pre>
</div>
<p>Output:</p>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash"># Funded: +50 USDC
# Tx hash: 7KLMnPqR2sTuWxYzAcBdEf7jKLMn
# New balance: 92.50 USDC
# Solana: https://explorer.solana.com/tx/7KLMnPqR2sTuW...</code></pre>
</div>
<!-- Policies -->
<h2 id="policies-cli">rail policies</h2>
<h3>rail policies get</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail policies get
# Daily budget: 100 USDC
# Per-call limit: 1.00 USDC
# Allowed domains: api.dune.com, api.browserbase.com, fal.ai
# Rate limit: 500 calls / 1h</code></pre>
</div>
<h3>rail policies set</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail policies set \
--daily-budget 100 \
--per-call-limit 1.00 \
--allowed-domains "api.dune.com,api.browserbase.com,fal.ai" \
--rate-limit "500/1h"
# Policy updated.</code></pre>
</div>
<div class="param-list">
<div class="param-item">
<div class="param-meta"><div class="param-name">--daily-budget</div><div class="param-type">number</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">Maximum USDC spend per calendar day (UTC).</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--per-call-limit</div><div class="param-type">number</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">Maximum USDC for any single payment.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--allowed-domains</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">Comma-separated list of allowed hostnames. Empty = no restriction.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--blocked-domains</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">Comma-separated list of blocked hostnames.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--rate-limit</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">Rate limit as <code>"N/window"</code>: e.g. <code>"500/1h"</code>, <code>"1000/24h"</code>, <code>"50/1m"</code>.</div>
</div>
</div>
<h3>rail policies clear</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail policies clear
# All spend policies cleared. Agent spending is now unconstrained.</code></pre>
</div>
<div class="callout callout-warn">
<span class="callout-icon">⚠️</span>
<div class="callout-body">
<code>rail policies clear</code> removes all spend constraints immediately. Only use in development, always configure policies before deploying agents to production.
</div>
</div>
<!-- Transactions -->
<h2 id="transactions-cli">rail transactions</h2>
<h3>rail transactions list</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash"># Last 20 transactions (default)
rail transactions list
# Filter by time window
rail transactions list --last 24h
rail transactions list --last 7d
rail transactions list --from 2026-05-01 --to 2026-05-31
# Filter by protocol
rail transactions list --protocol x402
# Limit and format
rail transactions list --limit 50 --json | jq '.[].txHash'</code></pre>
</div>
<p>Output:</p>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash"># HASH PROTOCOL USDC ENDPOINT STATUS TIME
# 5xGh9KmBv... x402 0.0020 api.dune.com confirmed 14:22:03
# 7KLMnPqR2s... mpp 0.0120 fal.run confirmed 14:21:47
# 4nLm8Yq3J... x402 0.0005 api.browserbase.com confirmed 14:21:12</code></pre>
</div>
<div class="param-list">
<div class="param-item">
<div class="param-meta"><div class="param-name">--last</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">Time window: <code>1h</code>, <code>24h</code>, <code>7d</code>, <code>30d</code>.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--from, --to</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">Date range. ISO 8601 date strings.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--protocol</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc"><code>x402</code> or <code>mpp</code>.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--limit</div><div class="param-type">number</div><div class="param-badges"><span class="badge badge-optional">optional</span><span class="badge badge-default">default: 20</span></div></div>
<div class="param-desc">Maximum results. Maximum: 100.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--agent</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">Override the agent ID. Useful for inspecting other agents if your API key has multi-agent scope.</div>
</div>
</div>
<h3>rail transactions get</h3>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash">rail transactions get 5xGh9KmBv...
# Hash: 5xGh9KmBv...
# Protocol: x402
# Amount: 0.002 USDC
# Endpoint: https://api.dune.com/api/v1/query/3326266/results
# Status: confirmed
# Timestamp: 2026-05-30T14:22:03Z
# Solana: https://explorer.solana.com/tx/5xGh9KmBv...</code></pre>
</div>
<!-- Pay -->
<h2 id="pay-cli">rail pay</h2>
<p>Route a one-off payment from the terminal, useful for testing endpoints or manual API calls.</p>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash"># Simple GET
rail pay --endpoint https://api.dune.com/api/v1/query/3326266/results
# POST with JSON body
rail pay \
--endpoint https://api.browserbase.com/v1/sessions \
--method POST \
--body '{"url": "https://example.com"}'
# Private payment (full ZK mode)
rail pay \
--endpoint https://api.proprietary.com/v1/signals \
--privacy full
# With idempotency key
rail pay \
--endpoint https://api.dune.com/api/v1/query/3326266/results \
--idempotency-key "manual-run-2026-05-30"</code></pre>
</div>
<div class="param-list">
<div class="param-item">
<div class="param-meta"><div class="param-name">--endpoint</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-required">required</span></div></div>
<div class="param-desc">Full HTTPS URL of the service to pay.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--method</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span><span class="badge badge-default">default: GET</span></div></div>
<div class="param-desc">HTTP method: GET, POST, PUT, PATCH, DELETE.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--body</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">JSON request body for POST/PUT/PATCH.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--header</div><div class="param-type">string (repeatable)</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">Custom header in <code>Key: Value</code> format. Can be specified multiple times.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--privacy</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc"><code>transparent</code> (default), <code>confidential_amount</code>, or <code>full</code>.</div>
</div>
<div class="param-item">
<div class="param-meta"><div class="param-name">--idempotency-key</div><div class="param-type">string</div><div class="param-badges"><span class="badge badge-optional">optional</span></div></div>
<div class="param-desc">Client idempotency key for safe retries.</div>
</div>
</div>
<!-- Shell completion -->
<h2 id="completion">Shell Completion</h2>
<div class="code-block">
<div class="code-block-header">
<span class="code-block-lang">bash</span>
<button class="code-block-copy">Copy</button>
</div>
<pre><code class="language-bash"># Bash
rail completion bash >> ~/.bash_profile
# Zsh
rail completion zsh >> ~/.zshrc
# Fish
rail completion fish > ~/.config/fish/completions/rail.fish</code></pre>
</div>
<nav class="page-nav">
<a href="sdk.html" class="page-nav-item">
<div class="page-nav-label">Previous</div>
<div class="page-nav-title">← SDK Reference</div>
</a>
<a href="api.html" class="page-nav-item page-nav-next">
<div class="page-nav-label">Next</div>
<div class="page-nav-title">API Reference →</div>
</a>
</nav>
</div>
</main>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/prism.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-bash.min.js"></script>
<script src="assets/app.js"></script>
</body>
</html>