xapi-to 0.1.12 → 0.1.13

package/README.md

@@ -21,6 +21,9 @@ cd xapi-cli && bun install
 # 1. Register a new account (apiKey saved automatically)
 xapi register
 
+# 1b. Or register with an inviter's referral code (please replace xapito to your referral code)
+xapi register --referral-code xapito
+
 # 2. Or set an existing key
 xapi config set apiKey=sk-xxx
 
@@ -76,6 +79,8 @@ xapi oauth providers                                 # list available providers
 
 ```bash
 xapi register                                        # create account, saves apiKey automatically
+xapi register --referral-code xapito                 # register with an inviter's referral code (please replace xapito to your referral code)
+xapi register xapito                                 # positional shorthand for --referral-code
 xapi balance                                         # show USD balance
 xapi topup                                           # generate payment URL
 xapi topup --method stripe --amount 10               # stripe, $10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xapi-to",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "description": "Agent-friendly CLI for xapi - discover and call capabilities and APIs",
   "type": "module",
   "bin": {

package/src/commands/config.ts

@@ -6,6 +6,25 @@ import { getConfig, saveConfig, showConfig } from '../config.ts';
 import { healthCheck } from '../client.ts';
 import { output, err } from '../format.ts';
 
+export const CONFIG_HELP = `xapi config - Manage CLI configuration
+
+USAGE
+  xapi config <command> [flags]
+
+COMMANDS
+  show                       Show current config (host, apiKey path, etc.)
+  set apiKey=<key>           Save API key to ~/.xapi/config.json
+  health                     Check backend connectivity (alias: xapi health)
+
+FLAGS
+  --format json|pretty|table   Output format
+
+EXAMPLES
+  xapi config show
+  xapi config set apiKey=xapi_abc123
+  xapi config health
+`;
+
 export async function configShow(args: string[], flags: Record<string, string>) {
   showConfig();
 }

package/src/commands/register.ts

@@ -2,34 +2,43 @@
  * register command: create a new user account
  *
  * POST /auth/register — no auth required
- * Returns apiKey (shown once), claimCode, claimUrl, tweetTemplate
+ * Returns apiKey (shown once), claimCode, referralCode, claimUrl, tweetTemplate
  * Automatically saves apiKey to ~/.xapi/config.json
+ *
+ * Optional referral code (please replace xapito to the actual referral code):
+ *   xapi register --referral-code xapito
+ *   xapi register --referralCode xapito     # alias
+ *   xapi register xapito                    # positional shorthand
  */
 
 import { XAPI_API_HOST, saveConfig, scheme } from '../config.ts';
 import { output, err } from '../format.ts';
 
-async function registerAccount() {
+interface RegisterResponse {
+  apiKey: string;
+  claimCode: string;
+  referralCode?: string;
+  claimSessionId: string;
+  claimUrl: string;
+  tweetTemplate: string;
+  user: { id: string; accountType: string };
+}
+
+async function registerAccount(referralCode?: string): Promise<RegisterResponse> {
   const controller = new AbortController();
   const timer = setTimeout(() => controller.abort(), 15_000);
   try {
     const res = await fetch(`${scheme(XAPI_API_HOST)}://${XAPI_API_HOST}/api/auth/register`, {
       method: 'POST',
       headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify(referralCode ? { referralCode } : {}),
       signal: controller.signal,
     });
     if (!res.ok) {
       const text = await res.text();
       throw new Error(`HTTP ${res.status}: ${text.slice(0, 300)}`);
     }
-    return res.json() as Promise<{
-      apiKey: string;
-      claimCode: string;
-      claimSessionId: string;
-      claimUrl: string;
-      tweetTemplate: string;
-      user: { id: string; accountType: string };
-    }>;
+    return res.json() as Promise<RegisterResponse>;
   } finally {
     clearTimeout(timer);
   }
@@ -37,20 +46,29 @@ async function registerAccount() {
 
 export async function register(args: string[], flags: Record<string, string>) {
   try {
-    const res = await registerAccount();
+    // 邀请码来源优先级：--referral-code > --referralCode > 第一个位置参数
+    const rawReferral =
+      flags['referral-code'] ?? flags['referralCode'] ?? args[0];
+    const referralCode =
+      typeof rawReferral === 'string' && rawReferral !== 'true' && rawReferral.length > 0
+        ? rawReferral
+        : undefined;
+
+    const res = await registerAccount(referralCode);
 
-    // auto-save apiKey
     saveConfig({ apiKey: res.apiKey });
 
     output({
       apiKey: res.apiKey,
       user: res.user,
+      referralCode: res.referralCode,
       claim: {
         code: res.claimCode,
         sessionId: res.claimSessionId,
         url: res.claimUrl,
       },
       tweetTemplate: res.tweetTemplate,
+      ...(referralCode ? { referredBy: referralCode } : {}),
       note: 'apiKey saved to ~/.xapi/config.json',
     }, flags.format as any);
   } catch (e: any) {

package/src/index.ts

@@ -12,6 +12,7 @@
  *
  *   xapi config show
  *   xapi config set apiKey=<key>
+ *   xapi config health
  *   xapi health
  *
  * Global flags:
@@ -26,6 +27,7 @@
 
 import * as actionCmds from './commands/action.ts';
 import * as cfgCmds from './commands/config.ts';
+const { CONFIG_HELP } = cfgCmds;
 import * as regCmds from './commands/register.ts';
 import * as topupCmds from './commands/topup.ts';
 import * as balanceCmds from './commands/balance.ts';
@@ -97,7 +99,8 @@ COMMANDS
   oauth unbind <binding-id>         Remove an OAuth binding
   oauth providers                   List available OAuth providers
 
-  register                          Create a new user account (apiKey saved automatically)
+  register [referral-code]          Create a new user account (apiKey saved automatically)
+    --referral-code <code>          Register with an inviter's referral code (also: --referralCode, or as positional arg)
   balance                           Show current account balance
   topup [--amount <usd>] [--method stripe|x402]   Generate payment URL
 
@@ -105,6 +108,7 @@ COMMANDS
 
   config show                       Show current config
   config set apiKey=<key>           Save API key to ~/.xapi/config.json
+  config health                     Check backend connectivity (alias: xapi health)
 
 GLOBAL FLAGS
   --format json|pretty|table        Output format (default: json)
@@ -117,6 +121,8 @@ ENV VARS
 
 EXAMPLES
   xapi register
+  xapi register --referral-code xapito          # register with an inviter's referral code
+  xapi register xapito                          # positional shorthand
   xapi list --format table
   xapi list --source capability
   xapi search twitter --source api
@@ -182,12 +188,17 @@ async function main() {
 
     // ── Config commands ──
     case 'config': {
+      if (flags.help || rest.length === 0) {
+        console.log(CONFIG_HELP);
+        process.exit(0);
+      }
       const [subCmd, ...subRest] = rest;
       switch (subCmd) {
         case 'show':   return cfgCmds.configShow(subRest, flags);
         case 'set':    return cfgCmds.configSet(subRest, flags);
+        case 'health': return cfgCmds.configHealth(subRest, flags);
         default:
-          console.error(JSON.stringify({ error: `unknown config command: ${subCmd}` }));
+          console.error(JSON.stringify({ error: `unknown config command: ${subCmd}`, hint: 'valid commands: show, set, health' }));
           process.exit(1);
       }
       break;