Skip to content

Commit 7b5d017

Browse files
simonbalfeclaude
simonbalfe
and
claude
committed
initial release: creatorcrawl CLI v0.1.0
Commander.js-based CLI that wraps @creatorcrawl/sdk. Publishes as unscoped 'creatorcrawl' on npm for clean install (npx creatorcrawl <command>). Covers all six platforms: tiktok, instagram, youtube, linkedin, twitter, reddit. ~38 subcommands. Outputs compact JSON by default (pipeable to jq). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
0 parents  commit 7b5d017

15 files changed

Lines changed: 1752 additions & 0 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: pnpm/action-setup@v4
15+
with:
16+
version: 9.15.0
17+
- uses: actions/setup-node@v4
18+
with:
19+
node-version: 20
20+
cache: pnpm
21+
- run: pnpm install --frozen-lockfile
22+
- run: pnpm type-check
23+
- run: pnpm build

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules
2+
dist
3+
*.log
4+
.DS_Store
5+
.env
6+
.env.local

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 CreatorCrawl
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# creatorcrawl CLI
2+
3+
Official command-line interface for [CreatorCrawl](https://creatorcrawl.com). Scrape **TikTok, Instagram, YouTube, LinkedIn, Twitter/X, and Reddit** from your terminal or shell scripts.
4+
5+
```bash
6+
npx creatorcrawl tiktok profile khaby.lame
7+
npx creatorcrawl youtube transcript https://youtu.be/...
8+
npx creatorcrawl linkedin company https://www.linkedin.com/company/openai
9+
```
10+
11+
## Install
12+
13+
Run instantly without installing:
14+
15+
```bash
16+
npx creatorcrawl <command>
17+
```
18+
19+
Or install globally:
20+
21+
```bash
22+
npm install -g creatorcrawl
23+
# or
24+
pnpm add -g creatorcrawl
25+
```
26+
27+
## Authenticate
28+
29+
Get a free API key at [creatorcrawl.com](https://creatorcrawl.com) — **250 credits free on signup, no card required.**
30+
31+
Then either:
32+
33+
```bash
34+
export CREATORCRAWL_API_KEY=cc_...
35+
creatorcrawl tiktok profile khaby.lame
36+
```
37+
38+
Or pass it per command:
39+
40+
```bash
41+
creatorcrawl --api-key cc_... tiktok profile khaby.lame
42+
```
43+
44+
## Commands
45+
46+
```
47+
creatorcrawl tiktok profile|videos|video|transcript|search|users|comments
48+
creatorcrawl instagram profile|posts|post|reels|comments|transcript
49+
creatorcrawl youtube channel|videos|shorts|video|search|transcript|comments|playlist
50+
creatorcrawl linkedin profile|company|company-posts|post|ads|ad
51+
creatorcrawl twitter profile|tweet|tweets|transcript|community|community-tweets
52+
creatorcrawl reddit search|subreddit|subreddit-posts|subreddit-search|comments
53+
```
54+
55+
Run `creatorcrawl <platform> --help` for subcommand details.
56+
57+
## Output
58+
59+
Default: compact JSON (greppable, pipeable).
60+
61+
```bash
62+
creatorcrawl tiktok profile khaby.lame | jq '.user.uniqueId, .stats.followerCount'
63+
```
64+
65+
Pretty-print:
66+
67+
```bash
68+
creatorcrawl --pretty tiktok profile khaby.lame
69+
```
70+
71+
## Examples
72+
73+
```bash
74+
# Profile
75+
creatorcrawl tiktok profile stoolpresidente
76+
77+
# Transcript a video and pipe to a file
78+
creatorcrawl youtube transcript https://youtu.be/dQw4w9WgXcQ > transcript.json
79+
80+
# Search and extract top-5 channels
81+
creatorcrawl youtube search "ai tools" | jq '.items[:5]'
82+
83+
# LinkedIn ad library lookup
84+
creatorcrawl linkedin ads stripe
85+
86+
# Loop over a list of handles
87+
for h in stoolpresidente khaby.lame zachking; do
88+
creatorcrawl tiktok profile "$h"
89+
done
90+
91+
# Use in CI / scripts
92+
CREATORCRAWL_API_KEY=$NPM_TOKEN \
93+
creatorcrawl reddit subreddit-posts ProgrammerHumor
94+
```
95+
96+
## Configuration
97+
98+
| Flag | Env var | Description |
99+
|---|---|---|
100+
| `-k`, `--api-key <key>` | `CREATORCRAWL_API_KEY` | Your CreatorCrawl API key |
101+
| `--pretty` | — | Pretty-print JSON output (default: compact) |
102+
103+
## Companion packages
104+
105+
- **TypeScript SDK:** [`@creatorcrawl/sdk`](https://www.npmjs.com/package/@creatorcrawl/sdk) — for code workflows
106+
- **MCP server:** [`@creatorcrawl/mcp`](https://www.npmjs.com/package/@creatorcrawl/mcp) — for AI agents (Claude, Cursor, Windsurf)
107+
- **Agent Skill:** [`creatorcrawl/creatorcrawl-skill`](https://github.com/creatorcrawl/creatorcrawl-skill) — teaches agents how to use CreatorCrawl
108+
109+
## Pricing
110+
111+
Pay-as-you-go credits starting at $29 for 5,000 calls. Full pricing at [creatorcrawl.com/#pricing](https://creatorcrawl.com/#pricing).
112+
113+
## License
114+
115+
MIT

‎package.json‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
{
2+
"name": "creatorcrawl",
3+
"version": "0.1.0",
4+
"description": "Official CLI for CreatorCrawl. Scrape TikTok, Instagram, YouTube, LinkedIn, Twitter/X, and Reddit profiles, posts, comments, transcripts, ads, and trending data from your terminal or shell scripts.",
5+
"license": "MIT",
6+
"author": "CreatorCrawl <support@creatorcrawl.com>",
7+
"homepage": "https://creatorcrawl.com",
8+
"repository": {
9+
"type": "git",
10+
"url": "git+https://github.com/creatorcrawl/cli.git"
11+
},
12+
"bugs": {
13+
"url": "https://github.com/creatorcrawl/cli/issues"
14+
},
15+
"keywords": [
16+
"creatorcrawl",
17+
"cli",
18+
"social-media-api",
19+
"tiktok",
20+
"instagram",
21+
"youtube",
22+
"linkedin",
23+
"twitter",
24+
"reddit",
25+
"scraper",
26+
"command-line"
27+
],
28+
"type": "module",
29+
"main": "./dist/index.js",
30+
"bin": {
31+
"creatorcrawl": "./dist/index.js"
32+
},
33+
"files": [
34+
"dist",
35+
"README.md",
36+
"LICENSE"
37+
],
38+
"scripts": {
39+
"build": "tsup",
40+
"dev": "tsx src/index.ts",
41+
"type-check": "tsc --noEmit",
42+
"prepublishOnly": "pnpm build"
43+
},
44+
"engines": {
45+
"node": ">=18"
46+
},
47+
"dependencies": {
48+
"@creatorcrawl/sdk": "^0.1.0",
49+
"commander": "^12.1.0"
50+
},
51+
"devDependencies": {
52+
"tsup": "^8.3.5",
53+
"tsx": "^4.21.0",
54+
"typescript": "^5.9.3"
55+
},
56+
"publishConfig": {
57+
"access": "public"
58+
}
59+
}

0 commit comments

Comments
 (0)