@hashscraper/cli
v0.1.1
Published
HashScraper CLI - Convert URLs to Markdown
Readme
@hashscraper/cli
Convert any URL to clean Markdown from the command line.
Powered by HashScraper — a web crawling and content extraction service.
Installation
npm install -g @hashscraper/cliRequires Node.js 18+.
Setup
Get your API key from hashscraper.com and configure it:
hashscraper config set api_key YOUR_API_KEYOr use environment variables:
export HASHSCRAPER_API_KEY=YOUR_API_KEYUsage
Convert a URL to Markdown
hashscraper https://example.comSave to file
hashscraper https://example.com -o output.mdMultiple URLs
hashscraper https://a.com https://b.com --output-dir ./resultsRead URLs from file
hashscraper --input urls.txt --output-dir ./resultsJSON output with metadata
hashscraper https://example.com --jsonPlain text format
hashscraper https://example.com --format textCommands
| Command | Description |
|---------|-------------|
| hashscraper <urls...> | Convert URLs to Markdown (default) |
| hashscraper credits | Show remaining credits |
| hashscraper config set <key> <value> | Set config (api_key, base_url) |
| hashscraper config get <key> | Get config value |
Options
| Option | Description | Default |
|--------|-------------|---------|
| --api-key <key> | API key (overrides config) | — |
| -o, --output <path> | Save to file (single URL only) | stdout |
| --output-dir <dir> | Save each result to directory | — |
| --format <format> | markdown or text | markdown |
| --json | Output as JSON with metadata | — |
| --timeout <ms> | Request timeout | 30000 |
| --input <file> | Read URLs from text file | — |
API Key Priority
--api-keyflagHASHSCRAPER_API_KEYenvironment variable~/.hashscraper/config.json
Exit Codes
| Code | Meaning | |------|---------| | 0 | All URLs processed successfully | | 1 | All URLs failed | | 2 | Partial failure (some succeeded, some failed) |
License
MIT
