xapi-to 0.1.12 → 0.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,19 +8,24 @@ Agent-friendly command-line interface for [xAPI](https://xapi.to) — discover a
8
8
  # Via npx (no install needed)
9
9
  npx xapi-to --help
10
10
 
11
- # Or install globally with bun
12
- bun add -g xapi-to
11
+ # Or install globally with npm
12
+ npm install -g xapi-to
13
13
 
14
14
  # Or from source
15
15
  cd xapi-cli && bun install
16
16
  ```
17
17
 
18
+ The published CLI runs on Node.js 18+. Bun is only required for local source development and tests.
19
+
18
20
  ## Quick Start
19
21
 
20
22
  ```bash
21
23
  # 1. Register a new account (apiKey saved automatically)
22
24
  xapi register
23
25
 
26
+ # 1b. Or register with an inviter's referral code (please replace xapito to your referral code)
27
+ xapi register --referral-code xapito
28
+
24
29
  # 2. Or set an existing key
25
30
  xapi config set apiKey=sk-xxx
26
31
 
@@ -76,6 +81,8 @@ xapi oauth providers # list available providers
76
81
 
77
82
  ```bash
78
83
  xapi register # create account, saves apiKey automatically
84
+ xapi register --referral-code xapito # register with an inviter's referral code (please replace xapito to your referral code)
85
+ xapi register xapito # positional shorthand for --referral-code
79
86
  xapi balance # show USD balance
80
87
  xapi topup # generate payment URL
81
88
  xapi topup --method stripe --amount 10 # stripe, $10