Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
name: CI
on:
push:
branches: [main]
pull_request:
jobs:
check:
name: Type-check & test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 24
cache: "pnpm"
- run: pnpm install --frozen-lockfile
- run: pnpm run type-check
- run: pnpm test
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ coverage/
.DS_Store
*.md
!README.md
!CONTRIBUTING.md

# Local-only agent context files (never commit — local knowledge base)
CLAUDE.md
Expand Down
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
# Contributing

Thanks for contributing to the Bright Data CLI. This is a TypeScript project that
compiles to a Node CLI (`brightdata` / `bdata`).

## Prerequisites

- **Node.js 20+** (CI builds on Node 24 — matching the current LTS avoids surprises).
- **pnpm** — pinned via the `packageManager` field. Let Corepack provide it:
```bash
corepack enable
```

## Setup

```bash
pnpm install
pnpm run build # compile src/ → dist/
node dist/index.js --help # run your build (or: pnpm start)
```

## Common commands

| Command | What it does |
|---|---|
| `pnpm run build` | Compile TypeScript to `dist/` |
| `pnpm run dev` | Compile in watch mode |
| `pnpm run type-check` | Type-check only, no emit (`tsc --noEmit`) |
| `pnpm test` | Run the test suite once (Vitest) |
| `pnpm run test:watch` | Run tests in watch mode |
| `pnpm start` | Run the built CLI (`node dist/index.js`) |
| `pnpm run clean` | Remove `dist/` |

## Project layout

```
src/
index.ts # entry point / bin (wires up all commands)
commands/ # one file per CLI command (scrape, search, browser, …)
browser/ # local browser-daemon: lifecycle, ipc, connection, interaction
utils/ # shared helpers (client, config, auth, output, polling, …)
types/ # shared type definitions
__tests__/ # Vitest tests, mirroring the src/ layout
install.sh # curl | sh installer
```

## Testing

- Tests live in `src/__tests__/**/*.test.ts`, mirroring the source tree, and run on
**Vitest** (`pnpm test`). Add a test alongside any behavior change.
- **CI does not run the suite** — `release.yml` only builds and publishes on release
tags. Please run `pnpm run type-check` **and** `pnpm test` locally before opening a
PR; that's the only safety net.
- A few browser/daemon tests depend on a real browser environment and may not pass on
every machine — note in your PR if a failure is pre-existing/environmental rather
than caused by your change.

## Code style

Match the surrounding file. The house style is:

- **`snake_case`** for functions and variables (`handle_scrape`, `ensure_authenticated`).
- **Allman braces** — opening brace on its own line for blocks:
```ts
if (!zone)
{
fail('...');
return;
}
```
- 4-space indentation, single quotes, arrow functions assigned to `const`, and
**named exports** grouped at the bottom of the file.
- Keep diffs minimal and consistent with the file you're editing.

## Commits & pull requests

- Use **Conventional Commits**: `feat(scraper): …`, `fix(browser): …`,
`docs(readme): …`, `refactor: …`, `chore: …`.
- Branch off `main` and open your PR against `main`.
- Before pushing: `pnpm run type-check && pnpm test && pnpm run build` should all pass.
- Keep PRs focused; describe what changed and how you verified it.

## Releases

Maintainers cut releases by bumping the version and pushing a `v*` tag, which triggers
the `release.yml` workflow to build and `npm publish`.
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@brightdata/cli",
"version": "0.3.1",
"version": "0.3.2",
"description": "Command-line interface for Bright Data. Scrape, search, extract structured data, and automate browsers directly from your terminal.",
"main": "dist/index.js",
"bin": {
Expand Down
10 changes: 6 additions & 4 deletions src/__tests__/commands/add-mcp.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,12 @@ const mocks = vi.hoisted(()=>({
warn: vi.fn(),
}));

vi.mock('@inquirer/prompts', ()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
vi.mock('../../utils/load-prompts', ()=>({
load_prompts: vi.fn(async()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
})),
}));

vi.mock('../../utils/credentials', ()=>({
Expand Down
41 changes: 41 additions & 0 deletions src/__tests__/utils/node-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import {describe, it, expect, vi} from 'vitest';
import {
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
} from '../../utils/node-version';

describe('utils/node-version (floor 20)', ()=>{
it('parses the major version', ()=>{
expect(parse_major('20.17.0')).toBe(20);
expect(parse_major('24.16.0')).toBe(24);
expect(parse_major('garbage')).toBe(0);
});

it('accepts >= 20, rejects < 20', ()=>{
expect(is_supported_node('20.0.0')).toBe(true);
expect(is_supported_node('22.12.0')).toBe(true);
expect(is_supported_node('24.16.0')).toBe(true);
expect(is_supported_node('18.19.0')).toBe(false);
});

it('names the detected version in the message', ()=>{
expect(unsupported_message('18.19.0')).toContain('v18.19.0');
expect(unsupported_message('18.19.0')).toContain('Node 20 or newer');
});

it('writes + exits 1 on unsupported, no-ops on supported', ()=>{
const write = vi.fn();
const exit = vi.fn();
assert_supported_node('18.19.0', write, exit as never);
expect(write).toHaveBeenCalledOnce();
expect(exit).toHaveBeenCalledWith(1);

write.mockClear();
exit.mockClear();
assert_supported_node('20.0.0', write, exit as never);
expect(write).not.toHaveBeenCalled();
expect(exit).not.toHaveBeenCalled();
});
});
5 changes: 4 additions & 1 deletion src/commands/add-mcp.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {checkbox, confirm, select} from '@inquirer/prompts';
import {Command} from 'commander';
import {load_prompts} from '../utils/load-prompts';
import {resolve_key} from '../utils/auth';
import {dim, green, red, warn} from '../utils/output';
import {
Expand DownExpand Up@@ -112,6 +112,7 @@ const resolve_selected_agents = async(
return null;
}

const {checkbox} = await load_prompts();
return await checkbox({
message: 'Which coding agents should Bright Data MCP be added to?',
choices: mcp_agents.map(agent=>({
Expand DownExpand Up@@ -177,6 +178,7 @@ const resolve_scope = async(
return null;
}

const {select} = await load_prompts();
return await select({
message: 'Install globally or for this project?',
choices: [
Expand DownExpand Up@@ -229,6 +231,7 @@ const write_agent_with_recovery = async(
);
}

const {confirm} = await load_prompts();
const overwrite = await confirm({
message: 'Overwrite invalid config at '+error.file_path+'?',
default: false,
Expand Down
7 changes: 6 additions & 1 deletion src/commands/init.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {Command} from 'commander';
import {confirm, input, password, select} from '@inquirer/prompts';
import {load_prompts} from '../utils/load-prompts';
import {validate_key, mask_key, resolve_key} from '../utils/auth';
import {get_api_key, save as save_credentials} from '../utils/credentials';
import {resolve, get as get_config, set as set_config} from '../utils/config';
Expand DownExpand Up@@ -97,6 +97,7 @@ const prompt_zone = async(
): Promise<string|undefined>=>{
if (!is_tty)
return suggested;
const {input, select} = await load_prompts();
if (!zone_names.length)
{
const typed = (await input({
Expand DownExpand Up@@ -131,6 +132,7 @@ const prompt_default_format = async(current: string|undefined):
Promise<string>=>{
if (!is_tty)
return current ?? 'markdown';
const {select} = await load_prompts();
const selected = await select({
message: 'Choose default output format',
choices: [
Expand DownExpand Up@@ -163,6 +165,7 @@ const prompt_api_key = async(
): Promise<string|undefined>=>{
if (!is_tty)
return initial;
const {confirm, password} = await load_prompts();
if (initial)
{
const reuse = await confirm({
Expand DownExpand Up@@ -238,6 +241,7 @@ const show_quick_start = (
const maybe_show_install_hint = async()=>{
if (!is_tty)
return;
const {confirm} = await load_prompts();
const show = await confirm({
message: 'Show global install command?',
default: false,
Expand DownExpand Up@@ -289,6 +293,7 @@ const handle_init = async(opts: Init_opts)=>{
serp_zone = pick_best_zone(zone_names, serp_zone ?? unlocker_zone);
if (is_tty)
{
const {confirm} = await load_prompts();
unlocker_zone = await prompt_zone(
'Select default Web Unlocker zone',
zone_names,
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/usr/bin/env node
import {Command} from 'commander';
import {assert_supported_node} from './utils/node-version';
import {maybe_run_browser_daemon} from './browser/entrypoint';
import {login_command} from './commands/login';
import {logout_command} from './commands/logout';
Expand DownExpand Up@@ -61,6 +62,7 @@ const build_program = ()=>{
};

const main = async()=>{
assert_supported_node();
if (await maybe_run_browser_daemon())
return;
build_program().parse(process.argv);
Expand Down
24 changes: 24 additions & 0 deletions src/utils/load-prompts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
// Full module type, erased at compile time (no runtime require emitted).
type Prompts_module = typeof import('@inquirer/prompts');

let prompts_promise: Promise<Prompts_module>|undefined;

// @inquirer/prompts is ESM-only. Under tsconfig `module: commonjs`, a literal
// import('@inquirer/prompts') is down-compiled by tsc back into require(), which
// throws ERR_REQUIRE_ESM on Node < 22.12 / < 20.19. Wrapping import() in
// new Function() hides it from the compiler so it is emitted as a genuine native
// dynamic import. Same technique as load_open() in utils/browser_auth.ts.
const load_prompts = (): Promise<Prompts_module>=>{
if (!prompts_promise)
{
const dynamic_import = new Function(
'specifier',
'return import(specifier);'
) as (specifier: string)=>Promise<Prompts_module>;
prompts_promise = dynamic_import('@inquirer/prompts');
}
return prompts_promise;
};

export {load_prompts};
export type {Prompts_module};
37 changes: 37 additions & 0 deletions src/utils/node-version.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
// Floor = genuine dependency minimum (driven by deps' own `engines`, e.g.
// commander), NOT the require(ESM) boundary. The dynamic-import loader in
// utils/load-prompts.ts removes the ERR_REQUIRE_ESM crash at its source, so the
// CLI runs on Node 20 again; this guard only catches runtimes below that floor.
const MIN_NODE_MAJOR = 20;

const parse_major = (version: string): number=>{
const major = Number(version.split('.')[0]);
return Number.isFinite(major) ? major : 0;
};

const is_supported_node = (version = process.versions.node): boolean=>
parse_major(version) >= MIN_NODE_MAJOR;

const unsupported_message = (version = process.versions.node): string=>
`✗ Unsupported Node.js version: you are running Node v${version}.\n`
+` @brightdata/cli requires Node ${MIN_NODE_MAJOR} or newer.\n`
+` Please update Node and try again: https://nodejs.org\n`;

const assert_supported_node = (
version = process.versions.node,
write: (s: string)=>void = s=>{ process.stderr.write(s); },
exit: (code: number)=>never = code=>process.exit(code),
): void=>{
if (is_supported_node(version))
return;
write(unsupported_message(version));
exit(1);
};

export {
MIN_NODE_MAJOR,
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
};
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
name: CI
on:
push:
branches: [main]
pull_request:
jobs:
check:
name: Type-check & test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 24
cache: "pnpm"
- run: pnpm install --frozen-lockfile
- run: pnpm run type-check
- run: pnpm test
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ coverage/
.DS_Store
*.md
!README.md
!CONTRIBUTING.md

# Local-only agent context files (never commit — local knowledge base)
CLAUDE.md
Expand Down
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
# Contributing

Thanks for contributing to the Bright Data CLI. This is a TypeScript project that
compiles to a Node CLI (`brightdata` / `bdata`).

## Prerequisites

- **Node.js 20+** (CI builds on Node 24 — matching the current LTS avoids surprises).
- **pnpm** — pinned via the `packageManager` field. Let Corepack provide it:
```bash
corepack enable
```

## Setup

```bash
pnpm install
pnpm run build # compile src/ → dist/
node dist/index.js --help # run your build (or: pnpm start)
```

## Common commands

| Command | What it does |
|---|---|
| `pnpm run build` | Compile TypeScript to `dist/` |
| `pnpm run dev` | Compile in watch mode |
| `pnpm run type-check` | Type-check only, no emit (`tsc --noEmit`) |
| `pnpm test` | Run the test suite once (Vitest) |
| `pnpm run test:watch` | Run tests in watch mode |
| `pnpm start` | Run the built CLI (`node dist/index.js`) |
| `pnpm run clean` | Remove `dist/` |

## Project layout

```
src/
index.ts # entry point / bin (wires up all commands)
commands/ # one file per CLI command (scrape, search, browser, …)
browser/ # local browser-daemon: lifecycle, ipc, connection, interaction
utils/ # shared helpers (client, config, auth, output, polling, …)
types/ # shared type definitions
__tests__/ # Vitest tests, mirroring the src/ layout
install.sh # curl | sh installer
```

## Testing

- Tests live in `src/__tests__/**/*.test.ts`, mirroring the source tree, and run on
**Vitest** (`pnpm test`). Add a test alongside any behavior change.
- **CI does not run the suite** — `release.yml` only builds and publishes on release
tags. Please run `pnpm run type-check` **and** `pnpm test` locally before opening a
PR; that's the only safety net.
- A few browser/daemon tests depend on a real browser environment and may not pass on
every machine — note in your PR if a failure is pre-existing/environmental rather
than caused by your change.

## Code style

Match the surrounding file. The house style is:

- **`snake_case`** for functions and variables (`handle_scrape`, `ensure_authenticated`).
- **Allman braces** — opening brace on its own line for blocks:
```ts
if (!zone)
{
fail('...');
return;
}
```
- 4-space indentation, single quotes, arrow functions assigned to `const`, and
**named exports** grouped at the bottom of the file.
- Keep diffs minimal and consistent with the file you're editing.

## Commits & pull requests

- Use **Conventional Commits**: `feat(scraper): …`, `fix(browser): …`,
`docs(readme): …`, `refactor: …`, `chore: …`.
- Branch off `main` and open your PR against `main`.
- Before pushing: `pnpm run type-check && pnpm test && pnpm run build` should all pass.
- Keep PRs focused; describe what changed and how you verified it.

## Releases

Maintainers cut releases by bumping the version and pushing a `v*` tag, which triggers
the `release.yml` workflow to build and `npm publish`.
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@brightdata/cli",
"version": "0.3.1",
"version": "0.3.2",
"description": "Command-line interface for Bright Data. Scrape, search, extract structured data, and automate browsers directly from your terminal.",
"main": "dist/index.js",
"bin": {
Expand Down
10 changes: 6 additions & 4 deletions src/__tests__/commands/add-mcp.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,12 @@ const mocks = vi.hoisted(()=>({
warn: vi.fn(),
}));

vi.mock('@inquirer/prompts', ()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
vi.mock('../../utils/load-prompts', ()=>({
load_prompts: vi.fn(async()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
})),
}));

vi.mock('../../utils/credentials', ()=>({
Expand Down
41 changes: 41 additions & 0 deletions src/__tests__/utils/node-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import {describe, it, expect, vi} from 'vitest';
import {
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
} from '../../utils/node-version';

describe('utils/node-version (floor 20)', ()=>{
it('parses the major version', ()=>{
expect(parse_major('20.17.0')).toBe(20);
expect(parse_major('24.16.0')).toBe(24);
expect(parse_major('garbage')).toBe(0);
});

it('accepts >= 20, rejects < 20', ()=>{
expect(is_supported_node('20.0.0')).toBe(true);
expect(is_supported_node('22.12.0')).toBe(true);
expect(is_supported_node('24.16.0')).toBe(true);
expect(is_supported_node('18.19.0')).toBe(false);
});

it('names the detected version in the message', ()=>{
expect(unsupported_message('18.19.0')).toContain('v18.19.0');
expect(unsupported_message('18.19.0')).toContain('Node 20 or newer');
});

it('writes + exits 1 on unsupported, no-ops on supported', ()=>{
const write = vi.fn();
const exit = vi.fn();
assert_supported_node('18.19.0', write, exit as never);
expect(write).toHaveBeenCalledOnce();
expect(exit).toHaveBeenCalledWith(1);

write.mockClear();
exit.mockClear();
assert_supported_node('20.0.0', write, exit as never);
expect(write).not.toHaveBeenCalled();
expect(exit).not.toHaveBeenCalled();
});
});
5 changes: 4 additions & 1 deletion src/commands/add-mcp.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {checkbox, confirm, select} from '@inquirer/prompts';
import {Command} from 'commander';
import {load_prompts} from '../utils/load-prompts';
import {resolve_key} from '../utils/auth';
import {dim, green, red, warn} from '../utils/output';
import {
Expand DownExpand Up@@ -112,6 +112,7 @@ const resolve_selected_agents = async(
return null;
}

const {checkbox} = await load_prompts();
return await checkbox({
message: 'Which coding agents should Bright Data MCP be added to?',
choices: mcp_agents.map(agent=>({
Expand DownExpand Up@@ -177,6 +178,7 @@ const resolve_scope = async(
return null;
}

const {select} = await load_prompts();
return await select({
message: 'Install globally or for this project?',
choices: [
Expand DownExpand Up@@ -229,6 +231,7 @@ const write_agent_with_recovery = async(
);
}

const {confirm} = await load_prompts();
const overwrite = await confirm({
message: 'Overwrite invalid config at '+error.file_path+'?',
default: false,
Expand Down
7 changes: 6 additions & 1 deletion src/commands/init.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {Command} from 'commander';
import {confirm, input, password, select} from '@inquirer/prompts';
import {load_prompts} from '../utils/load-prompts';
import {validate_key, mask_key, resolve_key} from '../utils/auth';
import {get_api_key, save as save_credentials} from '../utils/credentials';
import {resolve, get as get_config, set as set_config} from '../utils/config';
Expand DownExpand Up@@ -97,6 +97,7 @@ const prompt_zone = async(
): Promise<string|undefined>=>{
if (!is_tty)
return suggested;
const {input, select} = await load_prompts();
if (!zone_names.length)
{
const typed = (await input({
Expand DownExpand Up@@ -131,6 +132,7 @@ const prompt_default_format = async(current: string|undefined):
Promise<string>=>{
if (!is_tty)
return current ?? 'markdown';
const {select} = await load_prompts();
const selected = await select({
message: 'Choose default output format',
choices: [
Expand DownExpand Up@@ -163,6 +165,7 @@ const prompt_api_key = async(
): Promise<string|undefined>=>{
if (!is_tty)
return initial;
const {confirm, password} = await load_prompts();
if (initial)
{
const reuse = await confirm({
Expand DownExpand Up@@ -238,6 +241,7 @@ const show_quick_start = (
const maybe_show_install_hint = async()=>{
if (!is_tty)
return;
const {confirm} = await load_prompts();
const show = await confirm({
message: 'Show global install command?',
default: false,
Expand DownExpand Up@@ -289,6 +293,7 @@ const handle_init = async(opts: Init_opts)=>{
serp_zone = pick_best_zone(zone_names, serp_zone ?? unlocker_zone);
if (is_tty)
{
const {confirm} = await load_prompts();
unlocker_zone = await prompt_zone(
'Select default Web Unlocker zone',
zone_names,
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/usr/bin/env node
import {Command} from 'commander';
import {assert_supported_node} from './utils/node-version';
import {maybe_run_browser_daemon} from './browser/entrypoint';
import {login_command} from './commands/login';
import {logout_command} from './commands/logout';
Expand DownExpand Up@@ -61,6 +62,7 @@ const build_program = ()=>{
};

const main = async()=>{
assert_supported_node();
if (await maybe_run_browser_daemon())
return;
build_program().parse(process.argv);
Expand Down
24 changes: 24 additions & 0 deletions src/utils/load-prompts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
// Full module type, erased at compile time (no runtime require emitted).
type Prompts_module = typeof import('@inquirer/prompts');

let prompts_promise: Promise<Prompts_module>|undefined;

// @inquirer/prompts is ESM-only. Under tsconfig `module: commonjs`, a literal
// import('@inquirer/prompts') is down-compiled by tsc back into require(), which
// throws ERR_REQUIRE_ESM on Node < 22.12 / < 20.19. Wrapping import() in
// new Function() hides it from the compiler so it is emitted as a genuine native
// dynamic import. Same technique as load_open() in utils/browser_auth.ts.
const load_prompts = (): Promise<Prompts_module>=>{
if (!prompts_promise)
{
const dynamic_import = new Function(
'specifier',
'return import(specifier);'
) as (specifier: string)=>Promise<Prompts_module>;
prompts_promise = dynamic_import('@inquirer/prompts');
}
return prompts_promise;
};

export {load_prompts};
export type {Prompts_module};
37 changes: 37 additions & 0 deletions src/utils/node-version.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
// Floor = genuine dependency minimum (driven by deps' own `engines`, e.g.
// commander), NOT the require(ESM) boundary. The dynamic-import loader in
// utils/load-prompts.ts removes the ERR_REQUIRE_ESM crash at its source, so the
// CLI runs on Node 20 again; this guard only catches runtimes below that floor.
const MIN_NODE_MAJOR = 20;

const parse_major = (version: string): number=>{
const major = Number(version.split('.')[0]);
return Number.isFinite(major) ? major : 0;
};

const is_supported_node = (version = process.versions.node): boolean=>
parse_major(version) >= MIN_NODE_MAJOR;

const unsupported_message = (version = process.versions.node): string=>
`✗ Unsupported Node.js version: you are running Node v${version}.\n`
+` @brightdata/cli requires Node ${MIN_NODE_MAJOR} or newer.\n`
+` Please update Node and try again: https://nodejs.org\n`;

const assert_supported_node = (
version = process.versions.node,
write: (s: string)=>void = s=>{ process.stderr.write(s); },
exit: (code: number)=>never = code=>process.exit(code),
): void=>{
if (is_supported_node(version))
return;
write(unsupported_message(version));
exit(1);
};

export {
MIN_NODE_MAJOR,
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
};
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
name: CI
on:
push:
branches: [main]
pull_request:
jobs:
check:
name: Type-check & test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 24
cache: "pnpm"
- run: pnpm install --frozen-lockfile
- run: pnpm run type-check
- run: pnpm test
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ coverage/
.DS_Store
*.md
!README.md
!CONTRIBUTING.md

# Local-only agent context files (never commit — local knowledge base)
CLAUDE.md
Expand Down
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
# Contributing

Thanks for contributing to the Bright Data CLI. This is a TypeScript project that
compiles to a Node CLI (`brightdata` / `bdata`).

## Prerequisites

- **Node.js 20+** (CI builds on Node 24 — matching the current LTS avoids surprises).
- **pnpm** — pinned via the `packageManager` field. Let Corepack provide it:
```bash
corepack enable
```

## Setup

```bash
pnpm install
pnpm run build # compile src/ → dist/
node dist/index.js --help # run your build (or: pnpm start)
```

## Common commands

| Command | What it does |
|---|---|
| `pnpm run build` | Compile TypeScript to `dist/` |
| `pnpm run dev` | Compile in watch mode |
| `pnpm run type-check` | Type-check only, no emit (`tsc --noEmit`) |
| `pnpm test` | Run the test suite once (Vitest) |
| `pnpm run test:watch` | Run tests in watch mode |
| `pnpm start` | Run the built CLI (`node dist/index.js`) |
| `pnpm run clean` | Remove `dist/` |

## Project layout

```
src/
index.ts # entry point / bin (wires up all commands)
commands/ # one file per CLI command (scrape, search, browser, …)
browser/ # local browser-daemon: lifecycle, ipc, connection, interaction
utils/ # shared helpers (client, config, auth, output, polling, …)
types/ # shared type definitions
__tests__/ # Vitest tests, mirroring the src/ layout
install.sh # curl | sh installer
```

## Testing

- Tests live in `src/__tests__/**/*.test.ts`, mirroring the source tree, and run on
**Vitest** (`pnpm test`). Add a test alongside any behavior change.
- **CI does not run the suite** — `release.yml` only builds and publishes on release
tags. Please run `pnpm run type-check` **and** `pnpm test` locally before opening a
PR; that's the only safety net.
- A few browser/daemon tests depend on a real browser environment and may not pass on
every machine — note in your PR if a failure is pre-existing/environmental rather
than caused by your change.

## Code style

Match the surrounding file. The house style is:

- **`snake_case`** for functions and variables (`handle_scrape`, `ensure_authenticated`).
- **Allman braces** — opening brace on its own line for blocks:
```ts
if (!zone)
{
fail('...');
return;
}
```
- 4-space indentation, single quotes, arrow functions assigned to `const`, and
**named exports** grouped at the bottom of the file.
- Keep diffs minimal and consistent with the file you're editing.

## Commits & pull requests

- Use **Conventional Commits**: `feat(scraper): …`, `fix(browser): …`,
`docs(readme): …`, `refactor: …`, `chore: …`.
- Branch off `main` and open your PR against `main`.
- Before pushing: `pnpm run type-check && pnpm test && pnpm run build` should all pass.
- Keep PRs focused; describe what changed and how you verified it.

## Releases

Maintainers cut releases by bumping the version and pushing a `v*` tag, which triggers
the `release.yml` workflow to build and `npm publish`.
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@brightdata/cli",
"version": "0.3.1",
"version": "0.3.2",
"description": "Command-line interface for Bright Data. Scrape, search, extract structured data, and automate browsers directly from your terminal.",
"main": "dist/index.js",
"bin": {
Expand Down
10 changes: 6 additions & 4 deletions src/__tests__/commands/add-mcp.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,12 @@ const mocks = vi.hoisted(()=>({
warn: vi.fn(),
}));

vi.mock('@inquirer/prompts', ()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
vi.mock('../../utils/load-prompts', ()=>({
load_prompts: vi.fn(async()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
})),
}));

vi.mock('../../utils/credentials', ()=>({
Expand Down
41 changes: 41 additions & 0 deletions src/__tests__/utils/node-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import {describe, it, expect, vi} from 'vitest';
import {
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
} from '../../utils/node-version';

describe('utils/node-version (floor 20)', ()=>{
it('parses the major version', ()=>{
expect(parse_major('20.17.0')).toBe(20);
expect(parse_major('24.16.0')).toBe(24);
expect(parse_major('garbage')).toBe(0);
});

it('accepts >= 20, rejects < 20', ()=>{
expect(is_supported_node('20.0.0')).toBe(true);
expect(is_supported_node('22.12.0')).toBe(true);
expect(is_supported_node('24.16.0')).toBe(true);
expect(is_supported_node('18.19.0')).toBe(false);
});

it('names the detected version in the message', ()=>{
expect(unsupported_message('18.19.0')).toContain('v18.19.0');
expect(unsupported_message('18.19.0')).toContain('Node 20 or newer');
});

it('writes + exits 1 on unsupported, no-ops on supported', ()=>{
const write = vi.fn();
const exit = vi.fn();
assert_supported_node('18.19.0', write, exit as never);
expect(write).toHaveBeenCalledOnce();
expect(exit).toHaveBeenCalledWith(1);

write.mockClear();
exit.mockClear();
assert_supported_node('20.0.0', write, exit as never);
expect(write).not.toHaveBeenCalled();
expect(exit).not.toHaveBeenCalled();
});
});
5 changes: 4 additions & 1 deletion src/commands/add-mcp.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {checkbox, confirm, select} from '@inquirer/prompts';
import {Command} from 'commander';
import {load_prompts} from '../utils/load-prompts';
import {resolve_key} from '../utils/auth';
import {dim, green, red, warn} from '../utils/output';
import {
Expand DownExpand Up@@ -112,6 +112,7 @@ const resolve_selected_agents = async(
return null;
}

const {checkbox} = await load_prompts();
return await checkbox({
message: 'Which coding agents should Bright Data MCP be added to?',
choices: mcp_agents.map(agent=>({
Expand DownExpand Up@@ -177,6 +178,7 @@ const resolve_scope = async(
return null;
}

const {select} = await load_prompts();
return await select({
message: 'Install globally or for this project?',
choices: [
Expand DownExpand Up@@ -229,6 +231,7 @@ const write_agent_with_recovery = async(
);
}

const {confirm} = await load_prompts();
const overwrite = await confirm({
message: 'Overwrite invalid config at '+error.file_path+'?',
default: false,
Expand Down
7 changes: 6 additions & 1 deletion src/commands/init.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {Command} from 'commander';
import {confirm, input, password, select} from '@inquirer/prompts';
import {load_prompts} from '../utils/load-prompts';
import {validate_key, mask_key, resolve_key} from '../utils/auth';
import {get_api_key, save as save_credentials} from '../utils/credentials';
import {resolve, get as get_config, set as set_config} from '../utils/config';
Expand DownExpand Up@@ -97,6 +97,7 @@ const prompt_zone = async(
): Promise<string|undefined>=>{
if (!is_tty)
return suggested;
const {input, select} = await load_prompts();
if (!zone_names.length)
{
const typed = (await input({
Expand DownExpand Up@@ -131,6 +132,7 @@ const prompt_default_format = async(current: string|undefined):
Promise<string>=>{
if (!is_tty)
return current ?? 'markdown';
const {select} = await load_prompts();
const selected = await select({
message: 'Choose default output format',
choices: [
Expand DownExpand Up@@ -163,6 +165,7 @@ const prompt_api_key = async(
): Promise<string|undefined>=>{
if (!is_tty)
return initial;
const {confirm, password} = await load_prompts();
if (initial)
{
const reuse = await confirm({
Expand DownExpand Up@@ -238,6 +241,7 @@ const show_quick_start = (
const maybe_show_install_hint = async()=>{
if (!is_tty)
return;
const {confirm} = await load_prompts();
const show = await confirm({
message: 'Show global install command?',
default: false,
Expand DownExpand Up@@ -289,6 +293,7 @@ const handle_init = async(opts: Init_opts)=>{
serp_zone = pick_best_zone(zone_names, serp_zone ?? unlocker_zone);
if (is_tty)
{
const {confirm} = await load_prompts();
unlocker_zone = await prompt_zone(
'Select default Web Unlocker zone',
zone_names,
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/usr/bin/env node
import {Command} from 'commander';
import {assert_supported_node} from './utils/node-version';
import {maybe_run_browser_daemon} from './browser/entrypoint';
import {login_command} from './commands/login';
import {logout_command} from './commands/logout';
Expand DownExpand Up@@ -61,6 +62,7 @@ const build_program = ()=>{
};

const main = async()=>{
assert_supported_node();
if (await maybe_run_browser_daemon())
return;
build_program().parse(process.argv);
Expand Down
24 changes: 24 additions & 0 deletions src/utils/load-prompts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
// Full module type, erased at compile time (no runtime require emitted).
type Prompts_module = typeof import('@inquirer/prompts');

let prompts_promise: Promise<Prompts_module>|undefined;

// @inquirer/prompts is ESM-only. Under tsconfig `module: commonjs`, a literal
// import('@inquirer/prompts') is down-compiled by tsc back into require(), which
// throws ERR_REQUIRE_ESM on Node < 22.12 / < 20.19. Wrapping import() in
// new Function() hides it from the compiler so it is emitted as a genuine native
// dynamic import. Same technique as load_open() in utils/browser_auth.ts.
const load_prompts = (): Promise<Prompts_module>=>{
if (!prompts_promise)
{
const dynamic_import = new Function(
'specifier',
'return import(specifier);'
) as (specifier: string)=>Promise<Prompts_module>;
prompts_promise = dynamic_import('@inquirer/prompts');
}
return prompts_promise;
};

export {load_prompts};
export type {Prompts_module};
37 changes: 37 additions & 0 deletions src/utils/node-version.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
// Floor = genuine dependency minimum (driven by deps' own `engines`, e.g.
// commander), NOT the require(ESM) boundary. The dynamic-import loader in
// utils/load-prompts.ts removes the ERR_REQUIRE_ESM crash at its source, so the
// CLI runs on Node 20 again; this guard only catches runtimes below that floor.
const MIN_NODE_MAJOR = 20;

const parse_major = (version: string): number=>{
const major = Number(version.split('.')[0]);
return Number.isFinite(major) ? major : 0;
};

const is_supported_node = (version = process.versions.node): boolean=>
parse_major(version) >= MIN_NODE_MAJOR;

const unsupported_message = (version = process.versions.node): string=>
`✗ Unsupported Node.js version: you are running Node v${version}.\n`
+` @brightdata/cli requires Node ${MIN_NODE_MAJOR} or newer.\n`
+` Please update Node and try again: https://nodejs.org\n`;

const assert_supported_node = (
version = process.versions.node,
write: (s: string)=>void = s=>{ process.stderr.write(s); },
exit: (code: number)=>never = code=>process.exit(code),
): void=>{
if (is_supported_node(version))
return;
write(unsupported_message(version));
exit(1);
};

export {
MIN_NODE_MAJOR,
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
};
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
name: CI
on:
push:
branches: [main]
pull_request:
jobs:
check:
name: Type-check & test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 24
cache: "pnpm"
- run: pnpm install --frozen-lockfile
- run: pnpm run type-check
- run: pnpm test
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ coverage/
.DS_Store
*.md
!README.md
!CONTRIBUTING.md

# Local-only agent context files (never commit — local knowledge base)
CLAUDE.md
Expand Down
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
# Contributing

Thanks for contributing to the Bright Data CLI. This is a TypeScript project that
compiles to a Node CLI (`brightdata` / `bdata`).

## Prerequisites

- **Node.js 20+** (CI builds on Node 24 — matching the current LTS avoids surprises).
- **pnpm** — pinned via the `packageManager` field. Let Corepack provide it:
```bash
corepack enable
```

## Setup

```bash
pnpm install
pnpm run build # compile src/ → dist/
node dist/index.js --help # run your build (or: pnpm start)
```

## Common commands

| Command | What it does |
|---|---|
| `pnpm run build` | Compile TypeScript to `dist/` |
| `pnpm run dev` | Compile in watch mode |
| `pnpm run type-check` | Type-check only, no emit (`tsc --noEmit`) |
| `pnpm test` | Run the test suite once (Vitest) |
| `pnpm run test:watch` | Run tests in watch mode |
| `pnpm start` | Run the built CLI (`node dist/index.js`) |
| `pnpm run clean` | Remove `dist/` |

## Project layout

```
src/
index.ts # entry point / bin (wires up all commands)
commands/ # one file per CLI command (scrape, search, browser, …)
browser/ # local browser-daemon: lifecycle, ipc, connection, interaction
utils/ # shared helpers (client, config, auth, output, polling, …)
types/ # shared type definitions
__tests__/ # Vitest tests, mirroring the src/ layout
install.sh # curl | sh installer
```

## Testing

- Tests live in `src/__tests__/**/*.test.ts`, mirroring the source tree, and run on
**Vitest** (`pnpm test`). Add a test alongside any behavior change.
- **CI does not run the suite** — `release.yml` only builds and publishes on release
tags. Please run `pnpm run type-check` **and** `pnpm test` locally before opening a
PR; that's the only safety net.
- A few browser/daemon tests depend on a real browser environment and may not pass on
every machine — note in your PR if a failure is pre-existing/environmental rather
than caused by your change.

## Code style

Match the surrounding file. The house style is:

- **`snake_case`** for functions and variables (`handle_scrape`, `ensure_authenticated`).
- **Allman braces** — opening brace on its own line for blocks:
```ts
if (!zone)
{
fail('...');
return;
}
```
- 4-space indentation, single quotes, arrow functions assigned to `const`, and
**named exports** grouped at the bottom of the file.
- Keep diffs minimal and consistent with the file you're editing.

## Commits & pull requests

- Use **Conventional Commits**: `feat(scraper): …`, `fix(browser): …`,
`docs(readme): …`, `refactor: …`, `chore: …`.
- Branch off `main` and open your PR against `main`.
- Before pushing: `pnpm run type-check && pnpm test && pnpm run build` should all pass.
- Keep PRs focused; describe what changed and how you verified it.

## Releases

Maintainers cut releases by bumping the version and pushing a `v*` tag, which triggers
the `release.yml` workflow to build and `npm publish`.
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@brightdata/cli",
"version": "0.3.1",
"version": "0.3.2",
"description": "Command-line interface for Bright Data. Scrape, search, extract structured data, and automate browsers directly from your terminal.",
"main": "dist/index.js",
"bin": {
Expand Down
10 changes: 6 additions & 4 deletions src/__tests__/commands/add-mcp.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,12 @@ const mocks = vi.hoisted(()=>({
warn: vi.fn(),
}));

vi.mock('@inquirer/prompts', ()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
vi.mock('../../utils/load-prompts', ()=>({
load_prompts: vi.fn(async()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
})),
}));

vi.mock('../../utils/credentials', ()=>({
Expand Down
41 changes: 41 additions & 0 deletions src/__tests__/utils/node-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import {describe, it, expect, vi} from 'vitest';
import {
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
} from '../../utils/node-version';

describe('utils/node-version (floor 20)', ()=>{
it('parses the major version', ()=>{
expect(parse_major('20.17.0')).toBe(20);
expect(parse_major('24.16.0')).toBe(24);
expect(parse_major('garbage')).toBe(0);
});

it('accepts >= 20, rejects < 20', ()=>{
expect(is_supported_node('20.0.0')).toBe(true);
expect(is_supported_node('22.12.0')).toBe(true);
expect(is_supported_node('24.16.0')).toBe(true);
expect(is_supported_node('18.19.0')).toBe(false);
});

it('names the detected version in the message', ()=>{
expect(unsupported_message('18.19.0')).toContain('v18.19.0');
expect(unsupported_message('18.19.0')).toContain('Node 20 or newer');
});

it('writes + exits 1 on unsupported, no-ops on supported', ()=>{
const write = vi.fn();
const exit = vi.fn();
assert_supported_node('18.19.0', write, exit as never);
expect(write).toHaveBeenCalledOnce();
expect(exit).toHaveBeenCalledWith(1);

write.mockClear();
exit.mockClear();
assert_supported_node('20.0.0', write, exit as never);
expect(write).not.toHaveBeenCalled();
expect(exit).not.toHaveBeenCalled();
});
});
5 changes: 4 additions & 1 deletion src/commands/add-mcp.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {checkbox, confirm, select} from '@inquirer/prompts';
import {Command} from 'commander';
import {load_prompts} from '../utils/load-prompts';
import {resolve_key} from '../utils/auth';
import {dim, green, red, warn} from '../utils/output';
import {
Expand DownExpand Up@@ -112,6 +112,7 @@ const resolve_selected_agents = async(
return null;
}

const {checkbox} = await load_prompts();
return await checkbox({
message: 'Which coding agents should Bright Data MCP be added to?',
choices: mcp_agents.map(agent=>({
Expand DownExpand Up@@ -177,6 +178,7 @@ const resolve_scope = async(
return null;
}

const {select} = await load_prompts();
return await select({
message: 'Install globally or for this project?',
choices: [
Expand DownExpand Up@@ -229,6 +231,7 @@ const write_agent_with_recovery = async(
);
}

const {confirm} = await load_prompts();
const overwrite = await confirm({
message: 'Overwrite invalid config at '+error.file_path+'?',
default: false,
Expand Down
7 changes: 6 additions & 1 deletion src/commands/init.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {Command} from 'commander';
import {confirm, input, password, select} from '@inquirer/prompts';
import {load_prompts} from '../utils/load-prompts';
import {validate_key, mask_key, resolve_key} from '../utils/auth';
import {get_api_key, save as save_credentials} from '../utils/credentials';
import {resolve, get as get_config, set as set_config} from '../utils/config';
Expand DownExpand Up@@ -97,6 +97,7 @@ const prompt_zone = async(
): Promise<string|undefined>=>{
if (!is_tty)
return suggested;
const {input, select} = await load_prompts();
if (!zone_names.length)
{
const typed = (await input({
Expand DownExpand Up@@ -131,6 +132,7 @@ const prompt_default_format = async(current: string|undefined):
Promise<string>=>{
if (!is_tty)
return current ?? 'markdown';
const {select} = await load_prompts();
const selected = await select({
message: 'Choose default output format',
choices: [
Expand DownExpand Up@@ -163,6 +165,7 @@ const prompt_api_key = async(
): Promise<string|undefined>=>{
if (!is_tty)
return initial;
const {confirm, password} = await load_prompts();
if (initial)
{
const reuse = await confirm({
Expand DownExpand Up@@ -238,6 +241,7 @@ const show_quick_start = (
const maybe_show_install_hint = async()=>{
if (!is_tty)
return;
const {confirm} = await load_prompts();
const show = await confirm({
message: 'Show global install command?',
default: false,
Expand DownExpand Up@@ -289,6 +293,7 @@ const handle_init = async(opts: Init_opts)=>{
serp_zone = pick_best_zone(zone_names, serp_zone ?? unlocker_zone);
if (is_tty)
{
const {confirm} = await load_prompts();
unlocker_zone = await prompt_zone(
'Select default Web Unlocker zone',
zone_names,
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/usr/bin/env node
import {Command} from 'commander';
import {assert_supported_node} from './utils/node-version';
import {maybe_run_browser_daemon} from './browser/entrypoint';
import {login_command} from './commands/login';
import {logout_command} from './commands/logout';
Expand DownExpand Up@@ -61,6 +62,7 @@ const build_program = ()=>{
};

const main = async()=>{
assert_supported_node();
if (await maybe_run_browser_daemon())
return;
build_program().parse(process.argv);
Expand Down
24 changes: 24 additions & 0 deletions src/utils/load-prompts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
// Full module type, erased at compile time (no runtime require emitted).
type Prompts_module = typeof import('@inquirer/prompts');

let prompts_promise: Promise<Prompts_module>|undefined;

// @inquirer/prompts is ESM-only. Under tsconfig `module: commonjs`, a literal
// import('@inquirer/prompts') is down-compiled by tsc back into require(), which
// throws ERR_REQUIRE_ESM on Node < 22.12 / < 20.19. Wrapping import() in
// new Function() hides it from the compiler so it is emitted as a genuine native
// dynamic import. Same technique as load_open() in utils/browser_auth.ts.
const load_prompts = (): Promise<Prompts_module>=>{
if (!prompts_promise)
{
const dynamic_import = new Function(
'specifier',
'return import(specifier);'
) as (specifier: string)=>Promise<Prompts_module>;
prompts_promise = dynamic_import('@inquirer/prompts');
}
return prompts_promise;
};

export {load_prompts};
export type {Prompts_module};
37 changes: 37 additions & 0 deletions src/utils/node-version.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
// Floor = genuine dependency minimum (driven by deps' own `engines`, e.g.
// commander), NOT the require(ESM) boundary. The dynamic-import loader in
// utils/load-prompts.ts removes the ERR_REQUIRE_ESM crash at its source, so the
// CLI runs on Node 20 again; this guard only catches runtimes below that floor.
const MIN_NODE_MAJOR = 20;

const parse_major = (version: string): number=>{
const major = Number(version.split('.')[0]);
return Number.isFinite(major) ? major : 0;
};

const is_supported_node = (version = process.versions.node): boolean=>
parse_major(version) >= MIN_NODE_MAJOR;

const unsupported_message = (version = process.versions.node): string=>
`✗ Unsupported Node.js version: you are running Node v${version}.\n`
+` @brightdata/cli requires Node ${MIN_NODE_MAJOR} or newer.\n`
+` Please update Node and try again: https://nodejs.org\n`;

const assert_supported_node = (
version = process.versions.node,
write: (s: string)=>void = s=>{ process.stderr.write(s); },
exit: (code: number)=>never = code=>process.exit(code),
): void=>{
if (is_supported_node(version))
return;
write(unsupported_message(version));
exit(1);
};

export {
MIN_NODE_MAJOR,
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
};
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
name: CI
on:
push:
branches: [main]
pull_request:
jobs:
check:
name: Type-check & test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 24
cache: "pnpm"
- run: pnpm install --frozen-lockfile
- run: pnpm run type-check
- run: pnpm test
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ coverage/
.DS_Store
*.md
!README.md
!CONTRIBUTING.md

# Local-only agent context files (never commit — local knowledge base)
CLAUDE.md
Expand Down
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
# Contributing

Thanks for contributing to the Bright Data CLI. This is a TypeScript project that
compiles to a Node CLI (`brightdata` / `bdata`).

## Prerequisites

- **Node.js 20+** (CI builds on Node 24 — matching the current LTS avoids surprises).
- **pnpm** — pinned via the `packageManager` field. Let Corepack provide it:
```bash
corepack enable
```

## Setup

```bash
pnpm install
pnpm run build # compile src/ → dist/
node dist/index.js --help # run your build (or: pnpm start)
```

## Common commands

| Command | What it does |
|---|---|
| `pnpm run build` | Compile TypeScript to `dist/` |
| `pnpm run dev` | Compile in watch mode |
| `pnpm run type-check` | Type-check only, no emit (`tsc --noEmit`) |
| `pnpm test` | Run the test suite once (Vitest) |
| `pnpm run test:watch` | Run tests in watch mode |
| `pnpm start` | Run the built CLI (`node dist/index.js`) |
| `pnpm run clean` | Remove `dist/` |

## Project layout

```
src/
index.ts # entry point / bin (wires up all commands)
commands/ # one file per CLI command (scrape, search, browser, …)
browser/ # local browser-daemon: lifecycle, ipc, connection, interaction
utils/ # shared helpers (client, config, auth, output, polling, …)
types/ # shared type definitions
__tests__/ # Vitest tests, mirroring the src/ layout
install.sh # curl | sh installer
```

## Testing

- Tests live in `src/__tests__/**/*.test.ts`, mirroring the source tree, and run on
**Vitest** (`pnpm test`). Add a test alongside any behavior change.
- **CI does not run the suite** — `release.yml` only builds and publishes on release
tags. Please run `pnpm run type-check` **and** `pnpm test` locally before opening a
PR; that's the only safety net.
- A few browser/daemon tests depend on a real browser environment and may not pass on
every machine — note in your PR if a failure is pre-existing/environmental rather
than caused by your change.

## Code style

Match the surrounding file. The house style is:

- **`snake_case`** for functions and variables (`handle_scrape`, `ensure_authenticated`).
- **Allman braces** — opening brace on its own line for blocks:
```ts
if (!zone)
{
fail('...');
return;
}
```
- 4-space indentation, single quotes, arrow functions assigned to `const`, and
**named exports** grouped at the bottom of the file.
- Keep diffs minimal and consistent with the file you're editing.

## Commits & pull requests

- Use **Conventional Commits**: `feat(scraper): …`, `fix(browser): …`,
`docs(readme): …`, `refactor: …`, `chore: …`.
- Branch off `main` and open your PR against `main`.
- Before pushing: `pnpm run type-check && pnpm test && pnpm run build` should all pass.
- Keep PRs focused; describe what changed and how you verified it.

## Releases

Maintainers cut releases by bumping the version and pushing a `v*` tag, which triggers
the `release.yml` workflow to build and `npm publish`.
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@brightdata/cli",
"version": "0.3.1",
"version": "0.3.2",
"description": "Command-line interface for Bright Data. Scrape, search, extract structured data, and automate browsers directly from your terminal.",
"main": "dist/index.js",
"bin": {
Expand Down
10 changes: 6 additions & 4 deletions src/__tests__/commands/add-mcp.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,12 @@ const mocks = vi.hoisted(()=>({
warn: vi.fn(),
}));

vi.mock('@inquirer/prompts', ()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
vi.mock('../../utils/load-prompts', ()=>({
load_prompts: vi.fn(async()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
})),
}));

vi.mock('../../utils/credentials', ()=>({
Expand Down
41 changes: 41 additions & 0 deletions src/__tests__/utils/node-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import {describe, it, expect, vi} from 'vitest';
import {
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
} from '../../utils/node-version';

describe('utils/node-version (floor 20)', ()=>{
it('parses the major version', ()=>{
expect(parse_major('20.17.0')).toBe(20);
expect(parse_major('24.16.0')).toBe(24);
expect(parse_major('garbage')).toBe(0);
});

it('accepts >= 20, rejects < 20', ()=>{
expect(is_supported_node('20.0.0')).toBe(true);
expect(is_supported_node('22.12.0')).toBe(true);
expect(is_supported_node('24.16.0')).toBe(true);
expect(is_supported_node('18.19.0')).toBe(false);
});

it('names the detected version in the message', ()=>{
expect(unsupported_message('18.19.0')).toContain('v18.19.0');
expect(unsupported_message('18.19.0')).toContain('Node 20 or newer');
});

it('writes + exits 1 on unsupported, no-ops on supported', ()=>{
const write = vi.fn();
const exit = vi.fn();
assert_supported_node('18.19.0', write, exit as never);
expect(write).toHaveBeenCalledOnce();
expect(exit).toHaveBeenCalledWith(1);

write.mockClear();
exit.mockClear();
assert_supported_node('20.0.0', write, exit as never);
expect(write).not.toHaveBeenCalled();
expect(exit).not.toHaveBeenCalled();
});
});
5 changes: 4 additions & 1 deletion src/commands/add-mcp.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {checkbox, confirm, select} from '@inquirer/prompts';
import {Command} from 'commander';
import {load_prompts} from '../utils/load-prompts';
import {resolve_key} from '../utils/auth';
import {dim, green, red, warn} from '../utils/output';
import {
Expand DownExpand Up@@ -112,6 +112,7 @@ const resolve_selected_agents = async(
return null;
}

const {checkbox} = await load_prompts();
return await checkbox({
message: 'Which coding agents should Bright Data MCP be added to?',
choices: mcp_agents.map(agent=>({
Expand DownExpand Up@@ -177,6 +178,7 @@ const resolve_scope = async(
return null;
}

const {select} = await load_prompts();
return await select({
message: 'Install globally or for this project?',
choices: [
Expand DownExpand Up@@ -229,6 +231,7 @@ const write_agent_with_recovery = async(
);
}

const {confirm} = await load_prompts();
const overwrite = await confirm({
message: 'Overwrite invalid config at '+error.file_path+'?',
default: false,
Expand Down
7 changes: 6 additions & 1 deletion src/commands/init.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {Command} from 'commander';
import {confirm, input, password, select} from '@inquirer/prompts';
import {load_prompts} from '../utils/load-prompts';
import {validate_key, mask_key, resolve_key} from '../utils/auth';
import {get_api_key, save as save_credentials} from '../utils/credentials';
import {resolve, get as get_config, set as set_config} from '../utils/config';
Expand DownExpand Up@@ -97,6 +97,7 @@ const prompt_zone = async(
): Promise<string|undefined>=>{
if (!is_tty)
return suggested;
const {input, select} = await load_prompts();
if (!zone_names.length)
{
const typed = (await input({
Expand DownExpand Up@@ -131,6 +132,7 @@ const prompt_default_format = async(current: string|undefined):
Promise<string>=>{
if (!is_tty)
return current ?? 'markdown';
const {select} = await load_prompts();
const selected = await select({
message: 'Choose default output format',
choices: [
Expand DownExpand Up@@ -163,6 +165,7 @@ const prompt_api_key = async(
): Promise<string|undefined>=>{
if (!is_tty)
return initial;
const {confirm, password} = await load_prompts();
if (initial)
{
const reuse = await confirm({
Expand DownExpand Up@@ -238,6 +241,7 @@ const show_quick_start = (
const maybe_show_install_hint = async()=>{
if (!is_tty)
return;
const {confirm} = await load_prompts();
const show = await confirm({
message: 'Show global install command?',
default: false,
Expand DownExpand Up@@ -289,6 +293,7 @@ const handle_init = async(opts: Init_opts)=>{
serp_zone = pick_best_zone(zone_names, serp_zone ?? unlocker_zone);
if (is_tty)
{
const {confirm} = await load_prompts();
unlocker_zone = await prompt_zone(
'Select default Web Unlocker zone',
zone_names,
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/usr/bin/env node
import {Command} from 'commander';
import {assert_supported_node} from './utils/node-version';
import {maybe_run_browser_daemon} from './browser/entrypoint';
import {login_command} from './commands/login';
import {logout_command} from './commands/logout';
Expand DownExpand Up@@ -61,6 +62,7 @@ const build_program = ()=>{
};

const main = async()=>{
assert_supported_node();
if (await maybe_run_browser_daemon())
return;
build_program().parse(process.argv);
Expand Down
24 changes: 24 additions & 0 deletions src/utils/load-prompts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
// Full module type, erased at compile time (no runtime require emitted).
type Prompts_module = typeof import('@inquirer/prompts');

let prompts_promise: Promise<Prompts_module>|undefined;

// @inquirer/prompts is ESM-only. Under tsconfig `module: commonjs`, a literal
// import('@inquirer/prompts') is down-compiled by tsc back into require(), which
// throws ERR_REQUIRE_ESM on Node < 22.12 / < 20.19. Wrapping import() in
// new Function() hides it from the compiler so it is emitted as a genuine native
// dynamic import. Same technique as load_open() in utils/browser_auth.ts.
const load_prompts = (): Promise<Prompts_module>=>{
if (!prompts_promise)
{
const dynamic_import = new Function(
'specifier',
'return import(specifier);'
) as (specifier: string)=>Promise<Prompts_module>;
prompts_promise = dynamic_import('@inquirer/prompts');
}
return prompts_promise;
};

export {load_prompts};
export type {Prompts_module};
37 changes: 37 additions & 0 deletions src/utils/node-version.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
// Floor = genuine dependency minimum (driven by deps' own `engines`, e.g.
// commander), NOT the require(ESM) boundary. The dynamic-import loader in
// utils/load-prompts.ts removes the ERR_REQUIRE_ESM crash at its source, so the
// CLI runs on Node 20 again; this guard only catches runtimes below that floor.
const MIN_NODE_MAJOR = 20;

const parse_major = (version: string): number=>{
const major = Number(version.split('.')[0]);
return Number.isFinite(major) ? major : 0;
};

const is_supported_node = (version = process.versions.node): boolean=>
parse_major(version) >= MIN_NODE_MAJOR;

const unsupported_message = (version = process.versions.node): string=>
`✗ Unsupported Node.js version: you are running Node v${version}.\n`
+` @brightdata/cli requires Node ${MIN_NODE_MAJOR} or newer.\n`
+` Please update Node and try again: https://nodejs.org\n`;

const assert_supported_node = (
version = process.versions.node,
write: (s: string)=>void = s=>{ process.stderr.write(s); },
exit: (code: number)=>never = code=>process.exit(code),
): void=>{
if (is_supported_node(version))
return;
write(unsupported_message(version));
exit(1);
};

export {
MIN_NODE_MAJOR,
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
};
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
name: CI
on:
push:
branches: [main]
pull_request:
jobs:
check:
name: Type-check & test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 24
cache: "pnpm"
- run: pnpm install --frozen-lockfile
- run: pnpm run type-check
- run: pnpm test
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ coverage/
.DS_Store
*.md
!README.md
!CONTRIBUTING.md

# Local-only agent context files (never commit — local knowledge base)
CLAUDE.md
Expand Down
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
# Contributing

Thanks for contributing to the Bright Data CLI. This is a TypeScript project that
compiles to a Node CLI (`brightdata` / `bdata`).

## Prerequisites

- **Node.js 20+** (CI builds on Node 24 — matching the current LTS avoids surprises).
- **pnpm** — pinned via the `packageManager` field. Let Corepack provide it:
```bash
corepack enable
```

## Setup

```bash
pnpm install
pnpm run build # compile src/ → dist/
node dist/index.js --help # run your build (or: pnpm start)
```

## Common commands

| Command | What it does |
|---|---|
| `pnpm run build` | Compile TypeScript to `dist/` |
| `pnpm run dev` | Compile in watch mode |
| `pnpm run type-check` | Type-check only, no emit (`tsc --noEmit`) |
| `pnpm test` | Run the test suite once (Vitest) |
| `pnpm run test:watch` | Run tests in watch mode |
| `pnpm start` | Run the built CLI (`node dist/index.js`) |
| `pnpm run clean` | Remove `dist/` |

## Project layout

```
src/
index.ts # entry point / bin (wires up all commands)
commands/ # one file per CLI command (scrape, search, browser, …)
browser/ # local browser-daemon: lifecycle, ipc, connection, interaction
utils/ # shared helpers (client, config, auth, output, polling, …)
types/ # shared type definitions
__tests__/ # Vitest tests, mirroring the src/ layout
install.sh # curl | sh installer
```

## Testing

- Tests live in `src/__tests__/**/*.test.ts`, mirroring the source tree, and run on
**Vitest** (`pnpm test`). Add a test alongside any behavior change.
- **CI does not run the suite** — `release.yml` only builds and publishes on release
tags. Please run `pnpm run type-check` **and** `pnpm test` locally before opening a
PR; that's the only safety net.
- A few browser/daemon tests depend on a real browser environment and may not pass on
every machine — note in your PR if a failure is pre-existing/environmental rather
than caused by your change.

## Code style

Match the surrounding file. The house style is:

- **`snake_case`** for functions and variables (`handle_scrape`, `ensure_authenticated`).
- **Allman braces** — opening brace on its own line for blocks:
```ts
if (!zone)
{
fail('...');
return;
}
```
- 4-space indentation, single quotes, arrow functions assigned to `const`, and
**named exports** grouped at the bottom of the file.
- Keep diffs minimal and consistent with the file you're editing.

## Commits & pull requests

- Use **Conventional Commits**: `feat(scraper): …`, `fix(browser): …`,
`docs(readme): …`, `refactor: …`, `chore: …`.
- Branch off `main` and open your PR against `main`.
- Before pushing: `pnpm run type-check && pnpm test && pnpm run build` should all pass.
- Keep PRs focused; describe what changed and how you verified it.

## Releases

Maintainers cut releases by bumping the version and pushing a `v*` tag, which triggers
the `release.yml` workflow to build and `npm publish`.
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@brightdata/cli",
"version": "0.3.1",
"version": "0.3.2",
"description": "Command-line interface for Bright Data. Scrape, search, extract structured data, and automate browsers directly from your terminal.",
"main": "dist/index.js",
"bin": {
Expand Down
10 changes: 6 additions & 4 deletions src/__tests__/commands/add-mcp.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,12 @@ const mocks = vi.hoisted(()=>({
warn: vi.fn(),
}));

vi.mock('@inquirer/prompts', ()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
vi.mock('../../utils/load-prompts', ()=>({
load_prompts: vi.fn(async()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
})),
}));

vi.mock('../../utils/credentials', ()=>({
Expand Down
41 changes: 41 additions & 0 deletions src/__tests__/utils/node-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import {describe, it, expect, vi} from 'vitest';
import {
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
} from '../../utils/node-version';

describe('utils/node-version (floor 20)', ()=>{
it('parses the major version', ()=>{
expect(parse_major('20.17.0')).toBe(20);
expect(parse_major('24.16.0')).toBe(24);
expect(parse_major('garbage')).toBe(0);
});

it('accepts >= 20, rejects < 20', ()=>{
expect(is_supported_node('20.0.0')).toBe(true);
expect(is_supported_node('22.12.0')).toBe(true);
expect(is_supported_node('24.16.0')).toBe(true);
expect(is_supported_node('18.19.0')).toBe(false);
});

it('names the detected version in the message', ()=>{
expect(unsupported_message('18.19.0')).toContain('v18.19.0');
expect(unsupported_message('18.19.0')).toContain('Node 20 or newer');
});

it('writes + exits 1 on unsupported, no-ops on supported', ()=>{
const write = vi.fn();
const exit = vi.fn();
assert_supported_node('18.19.0', write, exit as never);
expect(write).toHaveBeenCalledOnce();
expect(exit).toHaveBeenCalledWith(1);

write.mockClear();
exit.mockClear();
assert_supported_node('20.0.0', write, exit as never);
expect(write).not.toHaveBeenCalled();
expect(exit).not.toHaveBeenCalled();
});
});
5 changes: 4 additions & 1 deletion src/commands/add-mcp.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {checkbox, confirm, select} from '@inquirer/prompts';
import {Command} from 'commander';
import {load_prompts} from '../utils/load-prompts';
import {resolve_key} from '../utils/auth';
import {dim, green, red, warn} from '../utils/output';
import {
Expand DownExpand Up@@ -112,6 +112,7 @@ const resolve_selected_agents = async(
return null;
}

const {checkbox} = await load_prompts();
return await checkbox({
message: 'Which coding agents should Bright Data MCP be added to?',
choices: mcp_agents.map(agent=>({
Expand DownExpand Up@@ -177,6 +178,7 @@ const resolve_scope = async(
return null;
}

const {select} = await load_prompts();
return await select({
message: 'Install globally or for this project?',
choices: [
Expand DownExpand Up@@ -229,6 +231,7 @@ const write_agent_with_recovery = async(
);
}

const {confirm} = await load_prompts();
const overwrite = await confirm({
message: 'Overwrite invalid config at '+error.file_path+'?',
default: false,
Expand Down
7 changes: 6 additions & 1 deletion src/commands/init.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {Command} from 'commander';
import {confirm, input, password, select} from '@inquirer/prompts';
import {load_prompts} from '../utils/load-prompts';
import {validate_key, mask_key, resolve_key} from '../utils/auth';
import {get_api_key, save as save_credentials} from '../utils/credentials';
import {resolve, get as get_config, set as set_config} from '../utils/config';
Expand DownExpand Up@@ -97,6 +97,7 @@ const prompt_zone = async(
): Promise<string|undefined>=>{
if (!is_tty)
return suggested;
const {input, select} = await load_prompts();
if (!zone_names.length)
{
const typed = (await input({
Expand DownExpand Up@@ -131,6 +132,7 @@ const prompt_default_format = async(current: string|undefined):
Promise<string>=>{
if (!is_tty)
return current ?? 'markdown';
const {select} = await load_prompts();
const selected = await select({
message: 'Choose default output format',
choices: [
Expand DownExpand Up@@ -163,6 +165,7 @@ const prompt_api_key = async(
): Promise<string|undefined>=>{
if (!is_tty)
return initial;
const {confirm, password} = await load_prompts();
if (initial)
{
const reuse = await confirm({
Expand DownExpand Up@@ -238,6 +241,7 @@ const show_quick_start = (
const maybe_show_install_hint = async()=>{
if (!is_tty)
return;
const {confirm} = await load_prompts();
const show = await confirm({
message: 'Show global install command?',
default: false,
Expand DownExpand Up@@ -289,6 +293,7 @@ const handle_init = async(opts: Init_opts)=>{
serp_zone = pick_best_zone(zone_names, serp_zone ?? unlocker_zone);
if (is_tty)
{
const {confirm} = await load_prompts();
unlocker_zone = await prompt_zone(
'Select default Web Unlocker zone',
zone_names,
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/usr/bin/env node
import {Command} from 'commander';
import {assert_supported_node} from './utils/node-version';
import {maybe_run_browser_daemon} from './browser/entrypoint';
import {login_command} from './commands/login';
import {logout_command} from './commands/logout';
Expand DownExpand Up@@ -61,6 +62,7 @@ const build_program = ()=>{
};

const main = async()=>{
assert_supported_node();
if (await maybe_run_browser_daemon())
return;
build_program().parse(process.argv);
Expand Down
24 changes: 24 additions & 0 deletions src/utils/load-prompts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
// Full module type, erased at compile time (no runtime require emitted).
type Prompts_module = typeof import('@inquirer/prompts');

let prompts_promise: Promise<Prompts_module>|undefined;

// @inquirer/prompts is ESM-only. Under tsconfig `module: commonjs`, a literal
// import('@inquirer/prompts') is down-compiled by tsc back into require(), which
// throws ERR_REQUIRE_ESM on Node < 22.12 / < 20.19. Wrapping import() in
// new Function() hides it from the compiler so it is emitted as a genuine native
// dynamic import. Same technique as load_open() in utils/browser_auth.ts.
const load_prompts = (): Promise<Prompts_module>=>{
if (!prompts_promise)
{
const dynamic_import = new Function(
'specifier',
'return import(specifier);'
) as (specifier: string)=>Promise<Prompts_module>;
prompts_promise = dynamic_import('@inquirer/prompts');
}
return prompts_promise;
};

export {load_prompts};
export type {Prompts_module};
37 changes: 37 additions & 0 deletions src/utils/node-version.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
// Floor = genuine dependency minimum (driven by deps' own `engines`, e.g.
// commander), NOT the require(ESM) boundary. The dynamic-import loader in
// utils/load-prompts.ts removes the ERR_REQUIRE_ESM crash at its source, so the
// CLI runs on Node 20 again; this guard only catches runtimes below that floor.
const MIN_NODE_MAJOR = 20;

const parse_major = (version: string): number=>{
const major = Number(version.split('.')[0]);
return Number.isFinite(major) ? major : 0;
};

const is_supported_node = (version = process.versions.node): boolean=>
parse_major(version) >= MIN_NODE_MAJOR;

const unsupported_message = (version = process.versions.node): string=>
`✗ Unsupported Node.js version: you are running Node v${version}.\n`
+` @brightdata/cli requires Node ${MIN_NODE_MAJOR} or newer.\n`
+` Please update Node and try again: https://nodejs.org\n`;

const assert_supported_node = (
version = process.versions.node,
write: (s: string)=>void = s=>{ process.stderr.write(s); },
exit: (code: number)=>never = code=>process.exit(code),
): void=>{
if (is_supported_node(version))
return;
write(unsupported_message(version));
exit(1);
};

export {
MIN_NODE_MAJOR,
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
};
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
name: CI
on:
push:
branches: [main]
pull_request:
jobs:
check:
name: Type-check & test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 24
cache: "pnpm"
- run: pnpm install --frozen-lockfile
- run: pnpm run type-check
- run: pnpm test
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ coverage/
.DS_Store
*.md
!README.md
!CONTRIBUTING.md

# Local-only agent context files (never commit — local knowledge base)
CLAUDE.md
Expand Down
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
# Contributing

Thanks for contributing to the Bright Data CLI. This is a TypeScript project that
compiles to a Node CLI (`brightdata` / `bdata`).

## Prerequisites

- **Node.js 20+** (CI builds on Node 24 — matching the current LTS avoids surprises).
- **pnpm** — pinned via the `packageManager` field. Let Corepack provide it:
```bash
corepack enable
```

## Setup

```bash
pnpm install
pnpm run build # compile src/ → dist/
node dist/index.js --help # run your build (or: pnpm start)
```

## Common commands

| Command | What it does |
|---|---|
| `pnpm run build` | Compile TypeScript to `dist/` |
| `pnpm run dev` | Compile in watch mode |
| `pnpm run type-check` | Type-check only, no emit (`tsc --noEmit`) |
| `pnpm test` | Run the test suite once (Vitest) |
| `pnpm run test:watch` | Run tests in watch mode |
| `pnpm start` | Run the built CLI (`node dist/index.js`) |
| `pnpm run clean` | Remove `dist/` |

## Project layout

```
src/
index.ts # entry point / bin (wires up all commands)
commands/ # one file per CLI command (scrape, search, browser, …)
browser/ # local browser-daemon: lifecycle, ipc, connection, interaction
utils/ # shared helpers (client, config, auth, output, polling, …)
types/ # shared type definitions
__tests__/ # Vitest tests, mirroring the src/ layout
install.sh # curl | sh installer
```

## Testing

- Tests live in `src/__tests__/**/*.test.ts`, mirroring the source tree, and run on
**Vitest** (`pnpm test`). Add a test alongside any behavior change.
- **CI does not run the suite** — `release.yml` only builds and publishes on release
tags. Please run `pnpm run type-check` **and** `pnpm test` locally before opening a
PR; that's the only safety net.
- A few browser/daemon tests depend on a real browser environment and may not pass on
every machine — note in your PR if a failure is pre-existing/environmental rather
than caused by your change.

## Code style

Match the surrounding file. The house style is:

- **`snake_case`** for functions and variables (`handle_scrape`, `ensure_authenticated`).
- **Allman braces** — opening brace on its own line for blocks:
```ts
if (!zone)
{
fail('...');
return;
}
```
- 4-space indentation, single quotes, arrow functions assigned to `const`, and
**named exports** grouped at the bottom of the file.
- Keep diffs minimal and consistent with the file you're editing.

## Commits & pull requests

- Use **Conventional Commits**: `feat(scraper): …`, `fix(browser): …`,
`docs(readme): …`, `refactor: …`, `chore: …`.
- Branch off `main` and open your PR against `main`.
- Before pushing: `pnpm run type-check && pnpm test && pnpm run build` should all pass.
- Keep PRs focused; describe what changed and how you verified it.

## Releases

Maintainers cut releases by bumping the version and pushing a `v*` tag, which triggers
the `release.yml` workflow to build and `npm publish`.
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@brightdata/cli",
"version": "0.3.1",
"version": "0.3.2",
"description": "Command-line interface for Bright Data. Scrape, search, extract structured data, and automate browsers directly from your terminal.",
"main": "dist/index.js",
"bin": {
Expand Down
10 changes: 6 additions & 4 deletions src/__tests__/commands/add-mcp.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,12 @@ const mocks = vi.hoisted(()=>({
warn: vi.fn(),
}));

vi.mock('@inquirer/prompts', ()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
vi.mock('../../utils/load-prompts', ()=>({
load_prompts: vi.fn(async()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
})),
}));

vi.mock('../../utils/credentials', ()=>({
Expand Down
41 changes: 41 additions & 0 deletions src/__tests__/utils/node-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import {describe, it, expect, vi} from 'vitest';
import {
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
} from '../../utils/node-version';

describe('utils/node-version (floor 20)', ()=>{
it('parses the major version', ()=>{
expect(parse_major('20.17.0')).toBe(20);
expect(parse_major('24.16.0')).toBe(24);
expect(parse_major('garbage')).toBe(0);
});

it('accepts >= 20, rejects < 20', ()=>{
expect(is_supported_node('20.0.0')).toBe(true);
expect(is_supported_node('22.12.0')).toBe(true);
expect(is_supported_node('24.16.0')).toBe(true);
expect(is_supported_node('18.19.0')).toBe(false);
});

it('names the detected version in the message', ()=>{
expect(unsupported_message('18.19.0')).toContain('v18.19.0');
expect(unsupported_message('18.19.0')).toContain('Node 20 or newer');
});

it('writes + exits 1 on unsupported, no-ops on supported', ()=>{
const write = vi.fn();
const exit = vi.fn();
assert_supported_node('18.19.0', write, exit as never);
expect(write).toHaveBeenCalledOnce();
expect(exit).toHaveBeenCalledWith(1);

write.mockClear();
exit.mockClear();
assert_supported_node('20.0.0', write, exit as never);
expect(write).not.toHaveBeenCalled();
expect(exit).not.toHaveBeenCalled();
});
});
5 changes: 4 additions & 1 deletion src/commands/add-mcp.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {checkbox, confirm, select} from '@inquirer/prompts';
import {Command} from 'commander';
import {load_prompts} from '../utils/load-prompts';
import {resolve_key} from '../utils/auth';
import {dim, green, red, warn} from '../utils/output';
import {
Expand DownExpand Up@@ -112,6 +112,7 @@ const resolve_selected_agents = async(
return null;
}

const {checkbox} = await load_prompts();
return await checkbox({
message: 'Which coding agents should Bright Data MCP be added to?',
choices: mcp_agents.map(agent=>({
Expand DownExpand Up@@ -177,6 +178,7 @@ const resolve_scope = async(
return null;
}

const {select} = await load_prompts();
return await select({
message: 'Install globally or for this project?',
choices: [
Expand DownExpand Up@@ -229,6 +231,7 @@ const write_agent_with_recovery = async(
);
}

const {confirm} = await load_prompts();
const overwrite = await confirm({
message: 'Overwrite invalid config at '+error.file_path+'?',
default: false,
Expand Down
7 changes: 6 additions & 1 deletion src/commands/init.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {Command} from 'commander';
import {confirm, input, password, select} from '@inquirer/prompts';
import {load_prompts} from '../utils/load-prompts';
import {validate_key, mask_key, resolve_key} from '../utils/auth';
import {get_api_key, save as save_credentials} from '../utils/credentials';
import {resolve, get as get_config, set as set_config} from '../utils/config';
Expand DownExpand Up@@ -97,6 +97,7 @@ const prompt_zone = async(
): Promise<string|undefined>=>{
if (!is_tty)
return suggested;
const {input, select} = await load_prompts();
if (!zone_names.length)
{
const typed = (await input({
Expand DownExpand Up@@ -131,6 +132,7 @@ const prompt_default_format = async(current: string|undefined):
Promise<string>=>{
if (!is_tty)
return current ?? 'markdown';
const {select} = await load_prompts();
const selected = await select({
message: 'Choose default output format',
choices: [
Expand DownExpand Up@@ -163,6 +165,7 @@ const prompt_api_key = async(
): Promise<string|undefined>=>{
if (!is_tty)
return initial;
const {confirm, password} = await load_prompts();
if (initial)
{
const reuse = await confirm({
Expand DownExpand Up@@ -238,6 +241,7 @@ const show_quick_start = (
const maybe_show_install_hint = async()=>{
if (!is_tty)
return;
const {confirm} = await load_prompts();
const show = await confirm({
message: 'Show global install command?',
default: false,
Expand DownExpand Up@@ -289,6 +293,7 @@ const handle_init = async(opts: Init_opts)=>{
serp_zone = pick_best_zone(zone_names, serp_zone ?? unlocker_zone);
if (is_tty)
{
const {confirm} = await load_prompts();
unlocker_zone = await prompt_zone(
'Select default Web Unlocker zone',
zone_names,
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/usr/bin/env node
import {Command} from 'commander';
import {assert_supported_node} from './utils/node-version';
import {maybe_run_browser_daemon} from './browser/entrypoint';
import {login_command} from './commands/login';
import {logout_command} from './commands/logout';
Expand DownExpand Up@@ -61,6 +62,7 @@ const build_program = ()=>{
};

const main = async()=>{
assert_supported_node();
if (await maybe_run_browser_daemon())
return;
build_program().parse(process.argv);
Expand Down
24 changes: 24 additions & 0 deletions src/utils/load-prompts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
// Full module type, erased at compile time (no runtime require emitted).
type Prompts_module = typeof import('@inquirer/prompts');

let prompts_promise: Promise<Prompts_module>|undefined;

// @inquirer/prompts is ESM-only. Under tsconfig `module: commonjs`, a literal
// import('@inquirer/prompts') is down-compiled by tsc back into require(), which
// throws ERR_REQUIRE_ESM on Node < 22.12 / < 20.19. Wrapping import() in
// new Function() hides it from the compiler so it is emitted as a genuine native
// dynamic import. Same technique as load_open() in utils/browser_auth.ts.
const load_prompts = (): Promise<Prompts_module>=>{
if (!prompts_promise)
{
const dynamic_import = new Function(
'specifier',
'return import(specifier);'
) as (specifier: string)=>Promise<Prompts_module>;
prompts_promise = dynamic_import('@inquirer/prompts');
}
return prompts_promise;
};

export {load_prompts};
export type {Prompts_module};
37 changes: 37 additions & 0 deletions src/utils/node-version.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
// Floor = genuine dependency minimum (driven by deps' own `engines`, e.g.
// commander), NOT the require(ESM) boundary. The dynamic-import loader in
// utils/load-prompts.ts removes the ERR_REQUIRE_ESM crash at its source, so the
// CLI runs on Node 20 again; this guard only catches runtimes below that floor.
const MIN_NODE_MAJOR = 20;

const parse_major = (version: string): number=>{
const major = Number(version.split('.')[0]);
return Number.isFinite(major) ? major : 0;
};

const is_supported_node = (version = process.versions.node): boolean=>
parse_major(version) >= MIN_NODE_MAJOR;

const unsupported_message = (version = process.versions.node): string=>
`✗ Unsupported Node.js version: you are running Node v${version}.\n`
+` @brightdata/cli requires Node ${MIN_NODE_MAJOR} or newer.\n`
+` Please update Node and try again: https://nodejs.org\n`;

const assert_supported_node = (
version = process.versions.node,
write: (s: string)=>void = s=>{ process.stderr.write(s); },
exit: (code: number)=>never = code=>process.exit(code),
): void=>{
if (is_supported_node(version))
return;
write(unsupported_message(version));
exit(1);
};

export {
MIN_NODE_MAJOR,
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
};
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
name: CI
on:
push:
branches: [main]
pull_request:
jobs:
check:
name: Type-check & test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
node-version: 24
cache: "pnpm"
- run: pnpm install --frozen-lockfile
- run: pnpm run type-check
- run: pnpm test
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ coverage/
.DS_Store
*.md
!README.md
!CONTRIBUTING.md

# Local-only agent context files (never commit — local knowledge base)
CLAUDE.md
Expand Down
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
# Contributing

Thanks for contributing to the Bright Data CLI. This is a TypeScript project that
compiles to a Node CLI (`brightdata` / `bdata`).

## Prerequisites

- **Node.js 20+** (CI builds on Node 24 — matching the current LTS avoids surprises).
- **pnpm** — pinned via the `packageManager` field. Let Corepack provide it:
```bash
corepack enable
```

## Setup

```bash
pnpm install
pnpm run build # compile src/ → dist/
node dist/index.js --help # run your build (or: pnpm start)
```

## Common commands

| Command | What it does |
|---|---|
| `pnpm run build` | Compile TypeScript to `dist/` |
| `pnpm run dev` | Compile in watch mode |
| `pnpm run type-check` | Type-check only, no emit (`tsc --noEmit`) |
| `pnpm test` | Run the test suite once (Vitest) |
| `pnpm run test:watch` | Run tests in watch mode |
| `pnpm start` | Run the built CLI (`node dist/index.js`) |
| `pnpm run clean` | Remove `dist/` |

## Project layout

```
src/
index.ts # entry point / bin (wires up all commands)
commands/ # one file per CLI command (scrape, search, browser, …)
browser/ # local browser-daemon: lifecycle, ipc, connection, interaction
utils/ # shared helpers (client, config, auth, output, polling, …)
types/ # shared type definitions
__tests__/ # Vitest tests, mirroring the src/ layout
install.sh # curl | sh installer
```

## Testing

- Tests live in `src/__tests__/**/*.test.ts`, mirroring the source tree, and run on
**Vitest** (`pnpm test`). Add a test alongside any behavior change.
- **CI does not run the suite** — `release.yml` only builds and publishes on release
tags. Please run `pnpm run type-check` **and** `pnpm test` locally before opening a
PR; that's the only safety net.
- A few browser/daemon tests depend on a real browser environment and may not pass on
every machine — note in your PR if a failure is pre-existing/environmental rather
than caused by your change.

## Code style

Match the surrounding file. The house style is:

- **`snake_case`** for functions and variables (`handle_scrape`, `ensure_authenticated`).
- **Allman braces** — opening brace on its own line for blocks:
```ts
if (!zone)
{
fail('...');
return;
}
```
- 4-space indentation, single quotes, arrow functions assigned to `const`, and
**named exports** grouped at the bottom of the file.
- Keep diffs minimal and consistent with the file you're editing.

## Commits & pull requests

- Use **Conventional Commits**: `feat(scraper): …`, `fix(browser): …`,
`docs(readme): …`, `refactor: …`, `chore: …`.
- Branch off `main` and open your PR against `main`.
- Before pushing: `pnpm run type-check && pnpm test && pnpm run build` should all pass.
- Keep PRs focused; describe what changed and how you verified it.

## Releases

Maintainers cut releases by bumping the version and pushing a `v*` tag, which triggers
the `release.yml` workflow to build and `npm publish`.
2 changes: 1 addition & 1 deletion package.json
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@brightdata/cli",
"version": "0.3.1",
"version": "0.3.2",
"description": "Command-line interface for Bright Data. Scrape, search, extract structured data, and automate browsers directly from your terminal.",
"main": "dist/index.js",
"bin": {
Expand Down
10 changes: 6 additions & 4 deletions src/__tests__/commands/add-mcp.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,10 +14,12 @@ const mocks = vi.hoisted(()=>({
warn: vi.fn(),
}));

vi.mock('@inquirer/prompts', ()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
vi.mock('../../utils/load-prompts', ()=>({
load_prompts: vi.fn(async()=>({
checkbox: mocks.checkbox,
select: mocks.select,
confirm: mocks.confirm,
})),
}));

vi.mock('../../utils/credentials', ()=>({
Expand Down
41 changes: 41 additions & 0 deletions src/__tests__/utils/node-version.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
import {describe, it, expect, vi} from 'vitest';
import {
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
} from '../../utils/node-version';

describe('utils/node-version (floor 20)', ()=>{
it('parses the major version', ()=>{
expect(parse_major('20.17.0')).toBe(20);
expect(parse_major('24.16.0')).toBe(24);
expect(parse_major('garbage')).toBe(0);
});

it('accepts >= 20, rejects < 20', ()=>{
expect(is_supported_node('20.0.0')).toBe(true);
expect(is_supported_node('22.12.0')).toBe(true);
expect(is_supported_node('24.16.0')).toBe(true);
expect(is_supported_node('18.19.0')).toBe(false);
});

it('names the detected version in the message', ()=>{
expect(unsupported_message('18.19.0')).toContain('v18.19.0');
expect(unsupported_message('18.19.0')).toContain('Node 20 or newer');
});

it('writes + exits 1 on unsupported, no-ops on supported', ()=>{
const write = vi.fn();
const exit = vi.fn();
assert_supported_node('18.19.0', write, exit as never);
expect(write).toHaveBeenCalledOnce();
expect(exit).toHaveBeenCalledWith(1);

write.mockClear();
exit.mockClear();
assert_supported_node('20.0.0', write, exit as never);
expect(write).not.toHaveBeenCalled();
expect(exit).not.toHaveBeenCalled();
});
});
5 changes: 4 additions & 1 deletion src/commands/add-mcp.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {checkbox, confirm, select} from '@inquirer/prompts';
import {Command} from 'commander';
import {load_prompts} from '../utils/load-prompts';
import {resolve_key} from '../utils/auth';
import {dim, green, red, warn} from '../utils/output';
import {
Expand DownExpand Up@@ -112,6 +112,7 @@ const resolve_selected_agents = async(
return null;
}

const {checkbox} = await load_prompts();
return await checkbox({
message: 'Which coding agents should Bright Data MCP be added to?',
choices: mcp_agents.map(agent=>({
Expand DownExpand Up@@ -177,6 +178,7 @@ const resolve_scope = async(
return null;
}

const {select} = await load_prompts();
return await select({
message: 'Install globally or for this project?',
choices: [
Expand DownExpand Up@@ -229,6 +231,7 @@ const write_agent_with_recovery = async(
);
}

const {confirm} = await load_prompts();
const overwrite = await confirm({
message: 'Overwrite invalid config at '+error.file_path+'?',
default: false,
Expand Down
7 changes: 6 additions & 1 deletion src/commands/init.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import {Command} from 'commander';
import {confirm, input, password, select} from '@inquirer/prompts';
import {load_prompts} from '../utils/load-prompts';
import {validate_key, mask_key, resolve_key} from '../utils/auth';
import {get_api_key, save as save_credentials} from '../utils/credentials';
import {resolve, get as get_config, set as set_config} from '../utils/config';
Expand DownExpand Up@@ -97,6 +97,7 @@ const prompt_zone = async(
): Promise<string|undefined>=>{
if (!is_tty)
return suggested;
const {input, select} = await load_prompts();
if (!zone_names.length)
{
const typed = (await input({
Expand DownExpand Up@@ -131,6 +132,7 @@ const prompt_default_format = async(current: string|undefined):
Promise<string>=>{
if (!is_tty)
return current ?? 'markdown';
const {select} = await load_prompts();
const selected = await select({
message: 'Choose default output format',
choices: [
Expand DownExpand Up@@ -163,6 +165,7 @@ const prompt_api_key = async(
): Promise<string|undefined>=>{
if (!is_tty)
return initial;
const {confirm, password} = await load_prompts();
if (initial)
{
const reuse = await confirm({
Expand DownExpand Up@@ -238,6 +241,7 @@ const show_quick_start = (
const maybe_show_install_hint = async()=>{
if (!is_tty)
return;
const {confirm} = await load_prompts();
const show = await confirm({
message: 'Show global install command?',
default: false,
Expand DownExpand Up@@ -289,6 +293,7 @@ const handle_init = async(opts: Init_opts)=>{
serp_zone = pick_best_zone(zone_names, serp_zone ?? unlocker_zone);
if (is_tty)
{
const {confirm} = await load_prompts();
unlocker_zone = await prompt_zone(
'Select default Web Unlocker zone',
zone_names,
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
#!/usr/bin/env node
import {Command} from 'commander';
import {assert_supported_node} from './utils/node-version';
import {maybe_run_browser_daemon} from './browser/entrypoint';
import {login_command} from './commands/login';
import {logout_command} from './commands/logout';
Expand DownExpand Up@@ -61,6 +62,7 @@ const build_program = ()=>{
};

const main = async()=>{
assert_supported_node();
if (await maybe_run_browser_daemon())
return;
build_program().parse(process.argv);
Expand Down
24 changes: 24 additions & 0 deletions src/utils/load-prompts.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
// Full module type, erased at compile time (no runtime require emitted).
type Prompts_module = typeof import('@inquirer/prompts');

let prompts_promise: Promise<Prompts_module>|undefined;

// @inquirer/prompts is ESM-only. Under tsconfig `module: commonjs`, a literal
// import('@inquirer/prompts') is down-compiled by tsc back into require(), which
// throws ERR_REQUIRE_ESM on Node < 22.12 / < 20.19. Wrapping import() in
// new Function() hides it from the compiler so it is emitted as a genuine native
// dynamic import. Same technique as load_open() in utils/browser_auth.ts.
const load_prompts = (): Promise<Prompts_module>=>{
if (!prompts_promise)
{
const dynamic_import = new Function(
'specifier',
'return import(specifier);'
) as (specifier: string)=>Promise<Prompts_module>;
prompts_promise = dynamic_import('@inquirer/prompts');
}
return prompts_promise;
};

export {load_prompts};
export type {Prompts_module};
37 changes: 37 additions & 0 deletions src/utils/node-version.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
// Floor = genuine dependency minimum (driven by deps' own `engines`, e.g.
// commander), NOT the require(ESM) boundary. The dynamic-import loader in
// utils/load-prompts.ts removes the ERR_REQUIRE_ESM crash at its source, so the
// CLI runs on Node 20 again; this guard only catches runtimes below that floor.
const MIN_NODE_MAJOR = 20;

const parse_major = (version: string): number=>{
const major = Number(version.split('.')[0]);
return Number.isFinite(major) ? major : 0;
};

const is_supported_node = (version = process.versions.node): boolean=>
parse_major(version) >= MIN_NODE_MAJOR;

const unsupported_message = (version = process.versions.node): string=>
`✗ Unsupported Node.js version: you are running Node v${version}.\n`
+` @brightdata/cli requires Node ${MIN_NODE_MAJOR} or newer.\n`
+` Please update Node and try again: https://nodejs.org\n`;

const assert_supported_node = (
version = process.versions.node,
write: (s: string)=>void = s=>{ process.stderr.write(s); },
exit: (code: number)=>never = code=>process.exit(code),
): void=>{
if (is_supported_node(version))
return;
write(unsupported_message(version));
exit(1);
};

export {
MIN_NODE_MAJOR,
parse_major,
is_supported_node,
unsupported_message,
assert_supported_node,
};