@hunt-labs/bytekit-cli
v0.2.2
Published
ByteKit CLI — wraps @hunt-labs/bytekit-sdk as shell subcommands
Readme
@hunt-labs/bytekit-cli
Command-line interface for the ByteKit API — scrape,
fetch, screenshot, search, crawl sitemaps, and manage page monitors from your
shell. Wraps @hunt-labs/bytekit-sdk.
Install
npm install -g @hunt-labs/bytekit-cliThis installs the bytekit binary on your PATH.
To run it without installing:
npx @hunt-labs/bytekit-cli scrape create --url https://example.comAlways use the fully-qualified
@hunt-labs/bytekit-cliname. The bare package namebytekiton the public npm registry belongs to an unrelated third-party project — running it by that short name fetches someone else's code, not this CLI. The shortbytekitname is only ever the binary you get after installing@hunt-labs/bytekit-cli.
Requires Node.js 18+.
Authentication
Create an API key at app.bytekit.com (keys are
prefixed sk_live_), then either export it:
export BYTEKIT_API_KEY=sk_live_xxx
bytekit scrape create --url https://example.comor pass it per-invocation with the global --key flag (which takes precedence
over the environment variable):
bytekit --key sk_live_xxx scrape create --url https://example.comPrecedence is --key flag → BYTEKIT_API_KEY → RAPIDCRAWL_API_KEY (legacy
fallback, deprecated — kept for existing scripts, will eventually be removed).
Without a key, the CLI exits with Error: API key required. Pass --key or set BYTEKIT_API_KEY.
Base-URL override
Requests go to https://api.bytekit.com by default. Point the CLI at staging, a
local gateway, or a proxy with the global --base-url flag or the
BYTEKIT_BASE_URL environment variable (the flag wins; RAPIDCRAWL_BASE_URL is
a deprecated legacy fallback):
bytekit --base-url https://api-stg.bytekit.com scrape create --url https://example.com
export BYTEKIT_BASE_URL=http://localhost:3001Global options
| Flag | Env var | Purpose |
| ------------------ | ----------------------------------------------------------- | -------------------------------------------------------------------- |
| --key <key> | BYTEKIT_API_KEY (legacy fallback: RAPIDCRAWL_API_KEY) | API key used for every request. |
| --base-url <url> | BYTEKIT_BASE_URL (legacy fallback: RAPIDCRAWL_BASE_URL) | API base URL (default https://api.bytekit.com). |
| --json | — | Print the raw JSON response instead of the human-readable rendering. |
Commands
scrape — scrape URL content
bytekit scrape create --url https://example.com --format markdown
bytekit scrape get sc_123abc
bytekit scrape bulk create --file urls.txt --webhook-url https://your.app/hooks/bytekitfetch — raw, unprocessed response bodies
bytekit fetch create --url https://example.com
bytekit fetch bulk create --file urls.txt --webhook-url https://your.app/hooks/bytekitsearch — ranked web search
bytekit search "ai web scraping" --limit 10 --country usscreenshots — capture a page
bytekit screenshots create --url https://example.com --full-page
bytekit screenshots get ss_123abcbulk — bulk screenshot jobs
bytekit bulk create --file urls.txt --webhook-url https://your.app/hooks/bytekit
bulk_id=bulk_123abc
bytekit bulk get "$bulk_id"
bytekit bulk screenshots list "$bulk_id"urls.txt is newline-delimited: one plain URL (or {"url":"https://..."}) per line.
monitors — watch a page for changes
bytekit monitors create --url https://example.com/pricing --interval-type daily \
--webhook-url https://your.app/hooks/bytekit
bytekit monitors list
bytekit monitors captures list mon_123abc
bytekit monitors delete mon_123abcsitemap — crawl a site's URL graph
bytekit sitemap create --url https://example.com
bytekit sitemap get sm_123abcaccount — account details and API keys
bytekit account get
bytekit account api-keys list
bytekit account api-keys create --name "ci-key"Documentation
Full API reference: bytekit.com/docs.
License
MIT — see LICENSE.
