Skip to content

CLI Reference

Nginjen ships as a single binary with subcommands for all operations.

Global Flags

FlagDescription
--config <PATH>Path to config TOML file
--verboseEnable verbose (debug) logging
--quietSuppress all output except errors
-h, --helpShow help
-V, --versionShow version

Commands

serve

Start the HTTP API server.

bash
nginjen serve [--host 0.0.0.0] [--port 9090]
FlagDefaultDescription
--host127.0.0.1Bind address
--port9090Listen port

scrape

Extract page content from a URL.

bash
nginjen scrape <URL> [--format html|text|markdown] [--wait 2000]
FlagDefaultDescription
<URL>(required)Target URL
--formattextOutput format: html, text, markdown
--wait2000Wait time in ms after load
--profilewindowsFingerprint profile

screenshot

Capture a screenshot of a URL.

bash
nginjen screenshot <URL> [-o output.png] [--width 1920] [--height 1080] [--full-page]
FlagDefaultDescription
<URL>(required)Target URL
-oscreenshot.pngOutput file path
--width1920Viewport width
--height1080Viewport height
--full-pagefalseCapture full page (not just viewport)

Search the web using built-in backends.

bash
nginjen search <QUERY> [--backend meta] [--limit 10]
FlagDefaultDescription
<QUERY>(required)Search query
--backendliteBackend: lite, bing, brave, meta, searxng
--limit10Max 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 path

doctor

Run diagnostic health checks.

bash
nginjen doctor

Checks 13 areas:

  1. Engine binary exists and is executable
  2. Engine version compatibility
  3. Network connectivity
  4. Disk space for temp files
  5. System dependencies (fonts, libs)
  6. Headless mode availability
  7. CDP connection
  8. Stealth injection
  9. Screenshot capability
  10. Cookie storage
  11. Proxy connectivity (if configured)
  12. Search backend connectivity
  13. 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 profile

Examples

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

Released under the MIT License.