@scrapecreators/cli 1.0.27 → 1.0.28

package/README.md

@@ -1,8 +1,8 @@
 # ScrapeCreators CLI
 
-CLI for the [ScrapeCreators API](https://scrapecreators.com) — scrape 27+ social media platforms from the terminal or as an MCP server for AI agents.
+CLI for the [ScrapeCreators API](https://scrapecreators.com) — use 180+ endpoints across 30+ platforms from the terminal or as an MCP server for AI agents.
 
-110+ endpoints. One command.
+180+ endpoints. One command.
 
 [Documentation](https://docs.scrapecreators.com/) | [OpenAPI Spec](https://docs.scrapecreators.com/openapi.json) | [Get API Key](https://app.scrapecreators.com)
 
@@ -20,7 +20,7 @@ npx @scrapecreators/cli tiktok profile --handle charlidamelio --api-key YOUR_KEY
 
 ## Quick Start
 
-1. Get your API key at [app.scrapecreators.com](https://app.scrapecreators.com)
+1. Get your API key at [app.scrapecreators.com](https://app.scrapecreators.com), or [sign up with GitHub](#sign-up-with-github-device-flow)
 
 2. Authenticate:
 
@@ -54,6 +54,44 @@ Three ways to authenticate, in priority order:
 
 Get your API key at [app.scrapecreators.com](https://app.scrapecreators.com).
 
+### Sign up with GitHub (device flow)
+
+New users can sign up with GitHub from a terminal or agent without creating a password. The GitHub path includes 10,000 free API calls and does not require a credit card. It uses GitHub's device flow, so the user authorizes with a short code instead of sharing GitHub credentials with the CLI or agent.
+
+This is separate from the `gh` CLI. Do not read or send a local `gh auth token`.
+
+1. Start the device flow:
+
+```bash
+curl -sS -X POST "https://api.scrapecreators.com/v1/github/device/code" \
+  -H "content-type: application/json" \
+  -d '{}'
+```
+
+The response includes `device_code`, `user_code`, `verification_uri`, `interval`, and `expires_in`. Open `verification_uri` (normally `https://github.com/login/device`) and enter the short `user_code`.
+
+2. Poll for authorization, waiting at least the returned `interval` between requests:
+
+```bash
+curl -sS -X POST "https://api.scrapecreators.com/v1/github/device/token" \
+  -H "content-type: application/json" \
+  -d '{"device_code":"YOUR_DEVICE_CODE"}'
+```
+
+Keep polling while authorization is pending. If the response says `slow_down`, increase the interval. Stop on `expired_token` or `access_denied`. A completed authorization returns `access_token`.
+
+3. Exchange that access token for the ScrapeCreators API key:
+
+```bash
+ACCESS_TOKEN="value returned by the token endpoint"
+curl -sS "https://api.scrapecreators.com/v1/github/device/profile" \
+  -H "Authorization: Bearer ${ACCESS_TOKEN}"
+```
+
+The response includes `api_key`. Save it with `scrapecreators auth login`, or set it as `SCRAPECREATORS_API_KEY` in the process that runs the CLI.
+
+**For agents:** ask before opening the GitHub page. Show the user only `user_code` and `verification_uri`; keep `device_code`, `access_token`, and `api_key` out of chat and logs. Persist the API key securely, then verify it with `scrapecreators balance` before claiming signup succeeded. If GitHub authorizes but the profile response has no `api_key`, the GitHub account may already be linked; have the user sign in at [app.scrapecreators.com](https://app.scrapecreators.com) to retrieve the existing key.
+
 ## Usage
 
 Every API endpoint is a subcommand under its platform:
@@ -85,7 +123,7 @@ scrapecreators instagram reels-search --query "dogs"
 scrapecreators reddit search --query "best programming languages"
 ```
 
-For the full list of 110+ endpoints across 27+ platforms, see the [API documentation](https://docs.scrapecreators.com/) or the [OpenAPI spec](https://docs.scrapecreators.com/openapi.json).
+For the full list of 180+ endpoints across 30+ platforms, see the [API documentation](https://docs.scrapecreators.com/) or the [OpenAPI spec](https://docs.scrapecreators.com/openapi.json).
 
 ### Discover Endpoints
 
@@ -176,7 +214,7 @@ All status messages (spinners, warnings) go to **stderr**. Data goes to **stdout
 
 ## AI Agent Integration
 
-The CLI is designed agent-first. All 110+ endpoints are also available as an [MCP server](https://api.scrapecreators.com/mcp) — no CLI installation required for agents.
+The CLI is designed agent-first. All 180+ endpoints are also available as an [MCP server](https://api.scrapecreators.com/mcp) — no CLI installation required for agents.
 
 ### MCP Server