Skip to content

Repository files navigation

creatorcrawl CLI

0.3 returns the new canonical response shape — see the SDK changelog for details.

Official command-line interface for CreatorCrawl. Scrape TikTok, Instagram, YouTube, LinkedIn, Twitter/X, and Reddit from your terminal or shell scripts.

Install

The standalone CLI is independent of the agent skill.

On macOS or Linux:

curl -fsSL https://creatorcrawl.com/install.sh | sh
creatorcrawl auth login
creatorcrawl tiktok profile khaby.lame

The installer sets up Node.js if needed and writes the command to ~/.local/bin/creatorcrawl without sudo. It installs only the CLI. Follow its PATH instructions if your shell cannot find the command. Override CREATORCRAWL_VERSION or CREATORCRAWL_BIN_DIR when needed.

With Node.js 18+, run the verified release using npx on macOS, Linux, or Windows:

npx --yes --package=https://github.com/creatorcrawl/cli/releases/download/v0.4.2/creatorcrawl-0.4.2.tgz creatorcrawl --help
npx --yes --package=https://github.com/creatorcrawl/cli/releases/download/v0.4.2/creatorcrawl-0.4.2.tgz creatorcrawl auth login

For a persistent command:

npm install -g https://github.com/creatorcrawl/cli/releases/download/v0.4.2/creatorcrawl-0.4.2.tgz
creatorcrawl --help

The updated npm package is awaiting publication; npm currently serves the older 0.3.0 release. Use the GitHub release commands above until publication completes.

Agent skill

Install the API-only skill separately for Claude Code, Codex, Cursor, or another coding agent:

npx skills add creatorcrawl/creatorcrawl-skill

Choose your agent and scope; add --global for use across projects. The skill includes API instructions, endpoint references, and research workflows. It calls REST directly using CREATORCRAWL_API_KEY in the agent environment; it does not install the CLI.

Authenticate

For interactive use, sign in through CreatorCrawl OAuth:

creatorcrawl auth login

The CLI opens CreatorCrawl in your browser or prints a sign-in link. Sign in or create an account, approve access, and return to your terminal. No API key is required. It uses Authorization Code + PKCE, stores OAuth credentials in macOS Keychain when available, and refreshes access automatically. For agents and CI, pass an API key non-interactively during installation:

curl -fsSL https://creatorcrawl.com/install.sh | CREATORCRAWL_API_KEY="sk_live_..." sh

API keys remain supported for automation:

export CREATORCRAWL_API_KEY=sk_live_...
creatorcrawl tiktok profile khaby.lame

Or pass it per command:

creatorcrawl --api-key sk_live_... tiktok profile khaby.lame

Use creatorcrawl auth status --json to check authentication and creatorcrawl auth logout to remove the saved credential.

Commands

creatorcrawl tiktok    profile|videos|video|transcript|search|users|comments
creatorcrawl instagram profile|posts|post|reels|comments|transcript
creatorcrawl youtube   channel|videos|shorts|video|search|transcript|comments|playlist
creatorcrawl linkedin  profile|company|company-posts|post|ads|ad
creatorcrawl twitter   profile|tweet|tweets|transcript|community|community-tweets
creatorcrawl reddit    search|subreddit|subreddit-posts|subreddit-search|comments

Run creatorcrawl <platform> --help for subcommand details.

Pagination

Paginated commands accept --cursor with the previous response's page.cursor. Commands that use page numbers accept --page instead. Check the command's --help. Each invocation fetches one page; stop collecting when page.has_more is false.

creatorcrawl tiktok videos luketriestech --sort latest
creatorcrawl tiktok videos luketriestech --sort latest --cursor 'CURSOR_FROM_PREVIOUS_RESPONSE'
creatorcrawl instagram posts example --cursor 'CURSOR_FROM_PREVIOUS_RESPONSE'
creatorcrawl youtube videos example --cursor 'CURSOR_FROM_PREVIOUS_RESPONSE'
creatorcrawl instagram search-reels 'tech reviews' --page 2

TikTok videos support --sort latest and --sort popular. Keep the same sort order while paging. Pagination options are available in builds from the main branch; the v0.4.2 release linked above does not include them yet.

Output

Default: compact JSON (greppable, pipeable).

All responses use a unified envelope: { data, page?, meta }. data holds the canonical record (Creator, Post, Comment, or a list of these). meta always includes platform and fetched_at.

creatorcrawl tiktok profile khaby.lame | jq '.data.handle, .data.follower_count'

Sample response:

{
  "data": {
    "handle": "khaby.lame",
    "follower_count": 162000000,
    "platform": "tiktok"
  },
  "meta": {
    "platform": "tiktok",
    "fetched_at": "2026-05-15T10:00:00Z"
  }
}

Pretty-print:

creatorcrawl --pretty tiktok profile khaby.lame

Examples

# Profile
creatorcrawl tiktok profile stoolpresidente

# Transcript a video and pipe to a file
creatorcrawl youtube transcript https://youtu.be/dQw4w9WgXcQ > transcript.json

# Search and extract top-5 channels
creatorcrawl youtube search "ai tools" | jq '.data[:5]'

# LinkedIn ad library lookup
creatorcrawl linkedin ads stripe

# Loop over a list of handles
for h in stoolpresidente khaby.lame zachking; do
  creatorcrawl tiktok profile "$h"
done

# Use in CI / scripts
CREATORCRAWL_API_KEY=sk_live_... \
  creatorcrawl reddit subreddit-posts ProgrammerHumor

Configuration

Flag Env var Description
-k, --api-key <key> CREATORCRAWL_API_KEY Your CreatorCrawl API key
--pretty — Pretty-print JSON output (default: compact)

Development and tests

Run pnpm install --frozen-lockfile, pnpm type-check, and pnpm test. The suite builds and executes the bundled CLI across every data command, including pagination, JSON output, API failures, credential precedence, and OAuth refresh. API responses come from an isolated local HTTP server; tests do not use live provider data, spend credits, or access your saved credentials. CI and release workflows run the same suite.

Companion packages

Pricing

Pay-as-you-go credits starting at $29 for 5,000 credits. Full pricing at creatorcrawl.com/#pricing.

License

MIT

About

Official CLI for CreatorCrawl. Scrape TikTok, Instagram, YouTube, LinkedIn, Twitter/X, and Reddit from your terminal or shell scripts.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages