CLI Reference
Nginjen ships as a single binary with subcommands for all operations.
Global Flags
| Flag | Description |
|---|---|
--config <PATH> | Path to config TOML file |
--verbose | Enable verbose (debug) logging |
--quiet | Suppress all output except errors |
-h, --help | Show help |
-V, --version | Show version |
Commands
serve
Start the HTTP API server.
bash
nginjen serve [--host 0.0.0.0] [--port 9090]| Flag | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Bind address |
--port | 9090 | Listen port |
scrape
Extract page content from a URL.
bash
nginjen scrape <URL> [--format html|text|markdown] [--wait 2000]| Flag | Default | Description |
|---|---|---|
<URL> | (required) | Target URL |
--format | text | Output format: html, text, markdown |
--wait | 2000 | Wait time in ms after load |
--profile | windows | Fingerprint profile |
screenshot
Capture a screenshot of a URL.
bash
nginjen screenshot <URL> [-o output.png] [--width 1920] [--height 1080] [--full-page]| Flag | Default | Description |
|---|---|---|
<URL> | (required) | Target URL |
-o | screenshot.png | Output file path |
--width | 1920 | Viewport width |
--height | 1080 | Viewport height |
--full-page | false | Capture full page (not just viewport) |
search
Search the web using built-in backends.
bash
nginjen search <QUERY> [--backend meta] [--limit 10]| Flag | Default | Description |
|---|---|---|
<QUERY> | (required) | Search query |
--backend | lite | Backend: lite, bing, brave, meta, searxng |
--limit | 10 | Max results |
engine
Manage the browser engine.
bash
nginjen engine status # Show engine status
nginjen engine download # Force download Chromium
nginjen engine path # Print engine binary pathdoctor
Run diagnostic health checks.
bash
nginjen doctorChecks 13 areas:
- Engine binary exists and is executable
- Engine version compatibility
- Network connectivity
- Disk space for temp files
- System dependencies (fonts, libs)
- Headless mode availability
- CDP connection
- Stealth injection
- Screenshot capability
- Cookie storage
- Proxy connectivity (if configured)
- Search backend connectivity
- API server bind
profiles
Manage fingerprint profiles.
bash
nginjen profiles list # List all profiles
nginjen profiles show <name> # Show profile details
nginjen profiles create <name> --os windows --browser chrome
nginjen profiles delete <name> # Delete custom profileExamples
bash
# Scrape and convert to markdown
nginjen scrape https://example.com --format markdown > page.md
# Screenshot at specific size
nginjen screenshot https://example.com -o wide.png --width 2560 --height 1440
# Full-page screenshot
nginjen screenshot https://example.com -o full.png --full-page
# Meta-search (fan-out to DDG + Bing + Brave)
nginjen search "rust web scraping" --backend meta --limit 20
# Run doctor to verify setup
nginjen doctor
# Start server on custom port with config
nginjen serve --port 8080 --config /etc/nginjen/config.toml