@hunt-labs/bytekit-cli 0.2.0 → 0.2.2

package/CHANGELOG.md

@@ -0,0 +1,72 @@
+# Changelog
+
+All notable changes to `@hunt-labs/bytekit-cli` are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+This file records only the delta between versions. For how to use the package
+today, see [README.md](./README.md), which remains the authoritative usage guide.
+
+## [0.2.2] - 2026-07-16
+
+### Changed
+
+- Re-release of 0.2.1. The 0.2.1 artifacts never reached npm — the prod publish's
+  `publish-sdk` step failed on a CI test-isolation flake (`cjs-require.test.ts`
+  rebuilding the shared `dist`), which is now fixed. No consumer-facing changes
+  beyond 0.2.1.
+
+## [0.2.1] - 2026-07-16
+
+### Changed
+
+- `BYTEKIT_API_KEY` / `BYTEKIT_BASE_URL` are now the primary environment
+  variables (precedence: flag > `BYTEKIT_*` > legacy `RAPIDCRAWL_*`).
+  `RAPIDCRAWL_API_KEY` / `RAPIDCRAWL_BASE_URL` continue to work as silent
+  fallbacks. `--help` text, the missing-key error, and the README now reference
+  `BYTEKIT_*`. (#2421)
+
+### Removed
+
+- The `recordings` command (the endpoint is permanently `410` deactivated). (#2421)
+
+## [0.2.0] - 2026-07-15
+
+Additive, lower-risk release — no breaking changes to existing commands.
+
+### Added
+
+- `scrape create --raw` / `-o, --output <file>`: write the raw response body to
+  stdout or a file (#2425).
+- Local `search --limit` validation via a commander `argParser`, so an invalid limit
+  is rejected before a request is sent (#2425).
+- One automatic retry on HTTP 429, honoring a clamped `Retry-After` header, in the
+  CLI transport (#2425).
+
+### Fixed
+
+- Entrypoint guard canonicalized so the `bytekit` bin runs correctly when invoked
+  through an npm/npx symlink (#2418).
+
+### Changed
+
+- Package renamed to `@hunt-labs/bytekit-cli` (the `@bytekit` npm scope was
+  unobtainable); the `bin` name stays `bytekit`. The prior `rapidcrawl-cli` name
+  remains installable at its last version but is deprecated.
+- Consumer call sites propagate the SDK's narrowed, spec-derived request types (#2426).
+- Publish-ready packaging metadata: dropped `main`, unpinned the SDK dependency to
+  `workspace:^`, added `engines`, `keywords`, `homepage`, `bugs`, `README.md`,
+  `LICENSE`, and an MIT `license` field.
+
+## [0.1.0] - 2026
+
+### Added
+
+- Initial release of the ByteKit CLI, wrapping the ByteKit SDK as shell
+  subcommands, published under the original `rapidcrawl-cli` name.
+
+[0.2.2]: https://github.com/Hunt-Labs-Inc/ByteKit/tree/main/packages/cli
+[0.2.1]: https://github.com/Hunt-Labs-Inc/ByteKit/tree/main/packages/cli
+[0.2.0]: https://github.com/Hunt-Labs-Inc/ByteKit/tree/main/packages/cli
+[0.1.0]: https://github.com/Hunt-Labs-Inc/ByteKit/tree/main/packages/cli

package/README.md

@@ -32,7 +32,7 @@ Create an API key at [app.bytekit.com](https://app.bytekit.com) (keys are
 prefixed `sk_live_`), then either export it:
 
 ```bash
-export RAPIDCRAWL_API_KEY=sk_live_xxx
+export BYTEKIT_API_KEY=sk_live_xxx
 bytekit scrape create --url https://example.com
 ```
 
@@ -43,26 +43,30 @@ over the environment variable):
 bytekit --key sk_live_xxx scrape create --url https://example.com
 ```
 
-Without a key, the CLI exits with `Error: API key required. Pass --key or set RAPIDCRAWL_API_KEY.`
+Precedence is `--key` flag → `BYTEKIT_API_KEY` → `RAPIDCRAWL_API_KEY` (legacy
+fallback, deprecated — kept for existing scripts, will eventually be removed).
+
+Without a key, the CLI exits with `Error: API key required. Pass --key or set BYTEKIT_API_KEY.`
 
 ## Base-URL override
 
 Requests go to `https://api.bytekit.com` by default. Point the CLI at staging, a
 local gateway, or a proxy with the global `--base-url` flag or the
-`RAPIDCRAWL_BASE_URL` environment variable (the flag wins):
+`BYTEKIT_BASE_URL` environment variable (the flag wins; `RAPIDCRAWL_BASE_URL` is
+a deprecated legacy fallback):
 
 ```bash
 bytekit --base-url https://api-stg.bytekit.com scrape create --url https://example.com
-export RAPIDCRAWL_BASE_URL=http://localhost:3001
+export BYTEKIT_BASE_URL=http://localhost:3001
 ```
 
 ## Global options
 
-| Flag               | Env var               | Purpose                                                              |
-| ------------------ | --------------------- | -------------------------------------------------------------------- |
-| `--key <key>`      | `RAPIDCRAWL_API_KEY`  | API key used for every request.                                      |
-| `--base-url <url>` | `RAPIDCRAWL_BASE_URL` | API base URL (default `https://api.bytekit.com`).                    |
-| `--json`           | —                     | Print the raw JSON response instead of the human-readable rendering. |
+| Flag               | Env var                                                     | Purpose                                                              |
+| ------------------ | ----------------------------------------------------------- | -------------------------------------------------------------------- |
+| `--key <key>`      | `BYTEKIT_API_KEY` (legacy fallback: `RAPIDCRAWL_API_KEY`)   | API key used for every request.                                      |
+| `--base-url <url>` | `BYTEKIT_BASE_URL` (legacy fallback: `RAPIDCRAWL_BASE_URL`) | API base URL (default `https://api.bytekit.com`).                    |
+| `--json`           | —                                                           | Print the raw JSON response instead of the human-readable rendering. |
 
 ## Commands
 
@@ -130,15 +134,6 @@ bytekit account api-keys list
 bytekit account api-keys create --name "ci-key"
 ```
 
-### `recordings` — deactivated
-
-```bash
-bytekit recordings get rec_123abc
-```
-
-The `/v1/recordings` endpoints are deactivated server-side and return HTTP 410;
-the subcommand remains only so existing scripts fail loudly rather than silently.
-
 ## Documentation
 
 Full API reference: [bytekit.com/docs](https://bytekit.com/docs).

package/dist/client.d.ts

@@ -47,8 +47,11 @@ export declare function createRetryingRequest(apiKey: string, baseUrl: string):
 /**
  * Build an authenticated SDK client from global CLI options.
  *
- * Resolution order for apiKey: --key flag → RAPIDCRAWL_API_KEY env var.
- * Exits with a descriptive error when no key is available.
+ * Resolution order (explicit input beats environment; new brand beats legacy brand):
+ *   apiKey:  --key flag → BYTEKIT_API_KEY → RAPIDCRAWL_API_KEY (legacy fallback).
+ *   baseUrl: --base-url flag → BYTEKIT_BASE_URL → RAPIDCRAWL_BASE_URL (legacy) → DEFAULT_BASE_URL.
+ * The legacy RAPIDCRAWL_* vars stay silently honored so existing setups keep working; exits with a
+ * descriptive error when no key is available.
  *
  * The returned client's `request` is replaced by the retrying transport, so every command inherits
  * the 429 retry from this one seam.

package/dist/client.js

@@ -102,19 +102,25 @@ export function createRetryingRequest(apiKey, baseUrl) {
 /**
  * Build an authenticated SDK client from global CLI options.
  *
- * Resolution order for apiKey: --key flag → RAPIDCRAWL_API_KEY env var.
- * Exits with a descriptive error when no key is available.
+ * Resolution order (explicit input beats environment; new brand beats legacy brand):
+ *   apiKey:  --key flag → BYTEKIT_API_KEY → RAPIDCRAWL_API_KEY (legacy fallback).
+ *   baseUrl: --base-url flag → BYTEKIT_BASE_URL → RAPIDCRAWL_BASE_URL (legacy) → DEFAULT_BASE_URL.
+ * The legacy RAPIDCRAWL_* vars stay silently honored so existing setups keep working; exits with a
+ * descriptive error when no key is available.
  *
  * The returned client's `request` is replaced by the retrying transport, so every command inherits
  * the 429 retry from this one seam.
  */
 export function buildClient(opts) {
-    const apiKey = opts.key ?? process.env['RAPIDCRAWL_API_KEY'];
+    const apiKey = opts.key ?? process.env['BYTEKIT_API_KEY'] ?? process.env['RAPIDCRAWL_API_KEY'];
     if (!apiKey) {
-        console.error('Error: API key required. Pass --key or set RAPIDCRAWL_API_KEY.');
+        console.error('Error: API key required. Pass --key or set BYTEKIT_API_KEY.');
         process.exit(1);
     }
-    const baseUrl = opts.baseUrl ?? process.env['RAPIDCRAWL_BASE_URL'] ?? DEFAULT_BASE_URL;
+    const baseUrl = opts.baseUrl ??
+        process.env['BYTEKIT_BASE_URL'] ??
+        process.env['RAPIDCRAWL_BASE_URL'] ??
+        DEFAULT_BASE_URL;
     const client = new RapidCrawl({ apiKey, baseUrl });
     client.request = createRetryingRequest(apiKey, baseUrl);
     return client;

package/dist/index.js

@@ -5,7 +5,6 @@ import { createRequire } from 'node:module';
 import { fileURLToPath } from 'node:url';
 import { makeScrapeCommand } from './commands/scrape.js';
 import { makeScreenshotsCommand } from './commands/screenshots.js';
-import { makeRecordingsCommand } from './commands/recordings.js';
 import { makeBulkCommand } from './commands/bulk.js';
 import { makeFetchCommand } from './commands/fetch.js';
 import { makeMonitorsCommand } from './commands/monitors.js';
@@ -25,8 +24,8 @@ export function buildProgram() {
         .name('bytekit')
         .description('ByteKit CLI — capture, scrape, monitor')
         .version(version)
-        .option('--key <key>', 'API key (or set RAPIDCRAWL_API_KEY)')
-        .option('--base-url <url>', 'Base URL override (or set RAPIDCRAWL_BASE_URL)')
+        .option('--key <key>', 'API key (or set BYTEKIT_API_KEY)')
+        .option('--base-url <url>', 'Base URL override (or set BYTEKIT_BASE_URL)')
         .option('--json', 'Output raw JSON');
     /** Read global options from the root program instance. */
     const getGlobal = () => {
@@ -39,7 +38,6 @@ export function buildProgram() {
     };
     program.addCommand(makeScrapeCommand(getGlobal));
     program.addCommand(makeScreenshotsCommand(getGlobal));
-    program.addCommand(makeRecordingsCommand(getGlobal));
     program.addCommand(makeBulkCommand(getGlobal));
     program.addCommand(makeFetchCommand(getGlobal));
     program.addCommand(makeMonitorsCommand(getGlobal));

package/dist/output.d.ts

@@ -59,8 +59,15 @@ export declare function extractRawBody(response: unknown, requestedFormat?: stri
 /**
  * Emit a raw body to the target.
  *
- * Uses `process.stdout.write`, never `console.log`: `console.log` appends a newline, which would
- * make the stdout bytes and the `--output` file bytes differ.
+ * Uses `process.stdout.write`, never `console.log`: `console.log` unconditionally appends a newline,
+ * which would make the stdout bytes and the `--output` file bytes differ.
+ *
+ * Trailing-newline rule (#2452 item 6): a body has no guaranteed trailing newline (a scraped markdown
+ * page rarely ends in one), so a naked `--raw` glued the shell prompt onto the last line. When stdout
+ * is an interactive TTY we append a single newline (idempotent — never doubling an existing one) so the
+ * prompt starts cleanly. Off a TTY (a pipe or `>`/`>>` redirect) we write the body verbatim, preserving
+ * the byte-exact invariant that `--raw > file` matches `--output file`. A FILE destination is never
+ * touched by this rule at all.
  */
 export declare function emitRaw(body: string, target: OutputTarget): void;
 /**

package/dist/output.js

@@ -74,15 +74,23 @@ export function extractRawBody(response, requestedFormat) {
 /**
  * Emit a raw body to the target.
  *
- * Uses `process.stdout.write`, never `console.log`: `console.log` appends a newline, which would
- * make the stdout bytes and the `--output` file bytes differ.
+ * Uses `process.stdout.write`, never `console.log`: `console.log` unconditionally appends a newline,
+ * which would make the stdout bytes and the `--output` file bytes differ.
+ *
+ * Trailing-newline rule (#2452 item 6): a body has no guaranteed trailing newline (a scraped markdown
+ * page rarely ends in one), so a naked `--raw` glued the shell prompt onto the last line. When stdout
+ * is an interactive TTY we append a single newline (idempotent — never doubling an existing one) so the
+ * prompt starts cleanly. Off a TTY (a pipe or `>`/`>>` redirect) we write the body verbatim, preserving
+ * the byte-exact invariant that `--raw > file` matches `--output file`. A FILE destination is never
+ * touched by this rule at all.
  */
 export function emitRaw(body, target) {
     if (target.file !== undefined) {
         writeFileSync(target.file, body);
         return;
     }
-    process.stdout.write(body);
+    const appendNewline = process.stdout.isTTY === true && !body.endsWith('\n');
+    process.stdout.write(appendNewline ? `${body}\n` : body);
 }
 /**
  * The single output dispatch a command calls — so no command needs `node:fs` and every rendering

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hunt-labs/bytekit-cli",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "ByteKit CLI — wraps @hunt-labs/bytekit-sdk as shell subcommands",
   "license": "MIT",
   "type": "module",
@@ -32,19 +32,16 @@
   ],
   "homepage": "https://bytekit.com/docs",
   "bugs": {
-    "email": "support@bytekit.com"
+    "email": "support@bytekit.com",
+    "url": "https://bytekit.com/contact"
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "dependencies": {
     "commander": "^12.0.0",
-    "@hunt-labs/bytekit-sdk": "^0.2.0"
-  },
-  "devDependencies": {
-    "@types/node": "^22.0.0",
-    "typescript": "^5.0.0",
-    "vitest": "^1.0.0"
+    "@hunt-labs/bytekit-sdk": "^0.2.2"
   },
   "scripts": {
     "build": "tsc",

package/dist/commands/recordings.d.ts

@@ -1,5 +0,0 @@
-import { Command } from 'commander';
-import { type GlobalOptions } from '../client.js';
-export declare function makeRecordingsCommand(getGlobal: () => GlobalOptions & {
-    json: boolean;
-}): Command;

package/dist/commands/recordings.js

@@ -1,36 +0,0 @@
-import { Command } from 'commander';
-import { buildClient } from '../client.js';
-import { printResult, handleError } from '../output.js';
-export function makeRecordingsCommand(getGlobal) {
-    const cmd = new Command('recordings').description('Recording operations');
-    cmd
-        .command('create')
-        .description('Start a page recording')
-        .requiredOption('--url <url>', 'URL to record')
-        .action(async (opts) => {
-        const g = getGlobal();
-        const client = buildClient(g);
-        try {
-            const result = await client.recordings.create({ url: opts.url });
-            printResult(result, g.json);
-        }
-        catch (err) {
-            handleError(err);
-        }
-    });
-    cmd
-        .command('get <id>')
-        .description('Get a recording by ID')
-        .action(async (id) => {
-        const g = getGlobal();
-        const client = buildClient(g);
-        try {
-            const result = await client.recordings.get(id);
-            printResult(result, g.json);
-        }
-        catch (err) {
-            handleError(err);
-        }
-    });
-    return cmd;
-}