@xcrawl/cli 0.2.2 → 0.2.4

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.3] - 2026-03-17
+
+### Changed
+- Updated `status` command to always call `https://api.xcrawl.com/web_v1/user/credit-user-info`.
+- Removed `--api-base-url` override from `status` to avoid ambiguous routing behavior.
+- Refined `README.md` structure to a more user-facing layout and removed the local development section.
+
 ## [0.2.0] - 2026-03-12
 
 ### Added

package/README.md

@@ -1,68 +1,71 @@
 # XCrawl CLI
 
-XCrawl CLI is a Node.js command-line tool for scraping, searching, mapping, and crawling websites.
+XCrawl CLI is the official command-line interface for XCrawl.
+Use it to scrape pages, run search queries, map sites, and manage crawl jobs from your terminal.
 
-## Install
+## Installation
 
-### Run with npx (no global install)
+Run directly with `npx`:
 
 ```bash
 npx -y @xcrawl/cli@latest doctor
 ```
 
-### Install globally with npm
+Install globally with npm:
 
 ```bash
 npm install -g @xcrawl/cli
 xcrawl --help
 ```
 
-## Authenticate
+## Quick Start
 
-Use either login command or environment variable.
+Authenticate:
 
 ```bash
-# Save API key locally
 xcrawl login --api-key <your_api_key>
-
-# Clear local API key
-xcrawl logout
-
-# Or use env var
-export XCRAWL_API_KEY=<your_api_key>
 ```
 
-## Quickstart
+Run core commands:
 
 ```bash
-# Scrape a page
 xcrawl scrape https://example.com --format markdown
-
-# Search
 xcrawl search "xcrawl cli" --limit 10
-
-# Show account and credit package status
 xcrawl status
-
-# Map links in a site
 xcrawl map https://example.com --limit 10
-
-# Start a crawl
 xcrawl crawl https://example.com
-
-# Check crawl status
 xcrawl crawl status <job-id>
 ```
 
-Default shortcut:
+Default shortcut for scrape:
 
 ```bash
 xcrawl https://example.com
-# same as:
-xcrawl scrape https://example.com
 ```
 
-## Batch Scraping
+## Authentication
+
+Use either local login or environment variable:
+
+```bash
+xcrawl login --api-key <your_api_key>
+xcrawl logout
+export XCRAWL_API_KEY=<your_api_key>
+```
+
+## Common Commands
+
+```bash
+xcrawl scrape <url...> [--format markdown|json|html|screenshot|text] [--output <path>] [--json]
+xcrawl search <query> [--limit <n>] [--json]
+xcrawl map <url> [--limit <n>] [--json]
+xcrawl crawl <url> [--wait]
+xcrawl crawl status <job-id>
+xcrawl status [--json]
+xcrawl doctor [--json]
+```
+
+Batch scrape example:
 
 ```bash
 xcrawl scrape --input ./urls.txt --concurrency 3 --json
@@ -70,7 +73,9 @@ xcrawl scrape --input ./urls.txt --concurrency 3 --json
 
 `urls.txt` should contain one URL per line. Lines starting with `#` are ignored.
 
-## Config
+## Configuration
+
+Manage config values:
 
 ```bash
 xcrawl config keys
@@ -78,7 +83,7 @@ xcrawl config get api-base-url
 xcrawl config set api-base-url https://run.xcrawl.com
 ```
 
-Config priority:
+Configuration priority:
 1. CLI flags
 2. Environment variables
 3. Local config file `~/.xcrawl/config.json`
@@ -93,28 +98,12 @@ Environment variables:
 
 ## Output
 
-- Default: human-readable text
-- `--json`: machine-readable JSON
-- `--output`: write output to file
-- Multi-URL scrape defaults to `.xcrawl/` when no output path is provided
+- Default output is human-readable text.
+- Use `--json` for machine-readable output.
+- Use `--output <path>` to save output to a file.
+- Multi-URL scrape defaults to `.xcrawl/` when no output path is provided.
 
-## Public API Notes
+## API Routing Notes
 
 - Default API base URL is `https://run.xcrawl.com`.
-- Account status endpoint: `GET /web_v1/user/credit-user-info`.
-
-## Local Development
-
-```bash
-npm install
-npm run build
-npm run test
-npm run lint
-```
-
-Real API smoke test:
-
-```bash
-export XCRAWL_API_KEY=<your_api_key>
-npm run smoke
-```
+- `status` always calls `https://api.xcrawl.com/web_v1/user/credit-user-info`.

package/dist/commands/status.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerStatusCommand = registerStatusCommand;
 const status_1 = require("../api/status");
 const auth_1 = require("../core/auth");
+const constants_1 = require("../core/constants");
 const output_1 = require("../core/output");
 const text_1 = require("../formatters/text");
 const validate_1 = require("../utils/validate");
@@ -12,7 +13,6 @@ function registerStatusCommand(program, context) {
         .command('status')
         .description('Show account profile and credit package status')
         .option('--api-key <key>', 'Override API key')
-        .option('--api-base-url <url>', 'Override API base URL')
         .option('--timeout <ms>', 'Request timeout in milliseconds')
         .option('--debug', 'Enable debug output')
         .option('--json', 'Output result as JSON')
@@ -20,11 +20,11 @@ function registerStatusCommand(program, context) {
         .action(async (options) => {
         const runtime = await (0, shared_1.resolveCommandRuntimeConfig)(context, {
             apiKey: options.apiKey,
-            apiBaseUrl: options.apiBaseUrl,
             timeoutMs: (0, validate_1.parsePositiveInt)(options.timeout, 'timeout'),
             debug: options.debug
         });
         runtime.apiKey = (0, auth_1.requireApiKey)(runtime.apiKey);
+        runtime.apiBaseUrl = constants_1.ACCOUNT_API_BASE_URL;
         const client = context.createApiClient(runtime);
         const outputPath = (0, shared_1.resolveOutputPath)(context, options.output);
         const result = await (0, status_1.fetchStatus)(client);

package/dist/commands/status.js.map

@@ -1 +1 @@
-{"version":3,"file":"status.js","sourceRoot":"","sources":["../../src/commands/status.ts"],"names":[],"mappings":";;AAmBA,sDAgCC;AAjDD,0CAA4C;AAC5C,uCAA6C;AAC7C,2CAA8C;AAC9C,6CAAkD;AAElD,gDAAqD;AACrD,qCAA0E;AAW1E,SAAgB,qBAAqB,CAAC,OAAgB,EAAE,OAAmB;IACzE,OAAO;SACJ,OAAO,CAAC,QAAQ,CAAC;SACjB,WAAW,CAAC,gDAAgD,CAAC;SAC7D,MAAM,CAAC,iBAAiB,EAAE,kBAAkB,CAAC;SAC7C,MAAM,CAAC,sBAAsB,EAAE,uBAAuB,CAAC;SACvD,MAAM,CAAC,gBAAgB,EAAE,iCAAiC,CAAC;SAC3D,MAAM,CAAC,SAAS,EAAE,qBAAqB,CAAC;SACxC,MAAM,CAAC,QAAQ,EAAE,uBAAuB,CAAC;SACzC,MAAM,CAAC,iBAAiB,EAAE,uBAAuB,CAAC;SAClD,MAAM,CAAC,KAAK,EAAE,OAAsB,EAAE,EAAE;QACvC,MAAM,OAAO,GAAG,MAAM,IAAA,oCAA2B,EAAC,OAAO,EAAE;YACzD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,SAAS,EAAE,IAAA,2BAAgB,EAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC;YACvD,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAEH,OAAO,CAAC,MAAM,GAAG,IAAA,oBAAa,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAE/C,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,IAAA,0BAAiB,EAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAW,EAAC,MAAM,CAAC,CAAC;QAEzC,MAAM,IAAA,qBAAY,EAAC;YACjB,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE;YAC/B,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU;YACV,UAAU,EAAE,mBAAY;SACzB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC"}
+{"version":3,"file":"status.js","sourceRoot":"","sources":["../../src/commands/status.ts"],"names":[],"mappings":";;AAmBA,sDA+BC;AAhDD,0CAA4C;AAC5C,uCAA6C;AAC7C,iDAAyD;AACzD,2CAA8C;AAC9C,6CAAkD;AAElD,gDAAqD;AACrD,qCAA0E;AAU1E,SAAgB,qBAAqB,CAAC,OAAgB,EAAE,OAAmB;IACzE,OAAO;SACJ,OAAO,CAAC,QAAQ,CAAC;SACjB,WAAW,CAAC,gDAAgD,CAAC;SAC7D,MAAM,CAAC,iBAAiB,EAAE,kBAAkB,CAAC;SAC7C,MAAM,CAAC,gBAAgB,EAAE,iCAAiC,CAAC;SAC3D,MAAM,CAAC,SAAS,EAAE,qBAAqB,CAAC;SACxC,MAAM,CAAC,QAAQ,EAAE,uBAAuB,CAAC;SACzC,MAAM,CAAC,iBAAiB,EAAE,uBAAuB,CAAC;SAClD,MAAM,CAAC,KAAK,EAAE,OAAsB,EAAE,EAAE;QACvC,MAAM,OAAO,GAAG,MAAM,IAAA,oCAA2B,EAAC,OAAO,EAAE;YACzD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,SAAS,EAAE,IAAA,2BAAgB,EAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC;YACvD,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAEH,OAAO,CAAC,MAAM,GAAG,IAAA,oBAAa,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/C,OAAO,CAAC,UAAU,GAAG,gCAAoB,CAAC;QAE1C,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,IAAA,0BAAiB,EAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAW,EAAC,MAAM,CAAC,CAAC;QAEzC,MAAM,IAAA,qBAAY,EAAC;YACjB,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE;YAC/B,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU;YACV,UAAU,EAAE,mBAAY;SACzB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/core/constants.d.ts

@@ -1,3 +1,4 @@
 import type { RuntimeConfig } from '../types/config';
 export declare const DEFAULT_API_BASE_URL = "https://run.xcrawl.com";
+export declare const ACCOUNT_API_BASE_URL = "https://api.xcrawl.com";
 export declare const DEFAULT_RUNTIME_CONFIG: RuntimeConfig;

package/dist/core/constants.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_RUNTIME_CONFIG = exports.DEFAULT_API_BASE_URL = void 0;
+exports.DEFAULT_RUNTIME_CONFIG = exports.ACCOUNT_API_BASE_URL = exports.DEFAULT_API_BASE_URL = void 0;
 exports.DEFAULT_API_BASE_URL = 'https://run.xcrawl.com';
+exports.ACCOUNT_API_BASE_URL = 'https://api.xcrawl.com';
 exports.DEFAULT_RUNTIME_CONFIG = {
     apiBaseUrl: exports.DEFAULT_API_BASE_URL,
     defaultFormat: 'markdown',

package/dist/core/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/core/constants.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG,wBAAwB,CAAC;AAEhD,QAAA,sBAAsB,GAAkB;IACnD,UAAU,EAAE,4BAAoB;IAChC,aAAa,EAAE,UAAU;IACzB,SAAS,EAAE,SAAS;IACpB,SAAS,EAAE,KAAK;IAChB,KAAK,EAAE,KAAK;CACb,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/core/constants.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG,wBAAwB,CAAC;AAChD,QAAA,oBAAoB,GAAG,wBAAwB,CAAC;AAEhD,QAAA,sBAAsB,GAAkB;IACnD,UAAU,EAAE,4BAAoB;IAChC,aAAa,EAAE,UAAU;IACzB,SAAS,EAAE,SAAS;IACpB,SAAS,EAAE,KAAK;IAChB,KAAK,EAAE,KAAK;CACb,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xcrawl/cli",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "XCrawl command line interface",
   "publishConfig": {
     "access": "public"