Robots

The maxun robots command group lets you create, list, inspect, and manage robots from the terminal.

List Robots

maxun robots list

Returns all robots as JSON by default. Use --table for a formatted view:

maxun robots list --table

Create an AI-powered robot from a natural language prompt. Maxun uses LLMs to infer the extraction schema from the page.

maxun robots extract -p <prompt> [options]

Option	Description
`-p, --prompt <text>`	Natural language description of what to extract (required)
`-u, --url <url>`	Target URL for the robot (optional)
`-n, --name <name>`	Robot name
`--provider <provider>`	LLM provider: `huggingface`, `openrouter` (default: `huggingface`)
`--model <model>`	LLM model name
`--api-key <key>`	LLM API key

Example:

maxun robots extract \
  -p "Extract all product names and prices" \
  -u "https://example.com/shop" \
  -n "Shop Extractor"

Create a single-page scraping robot.

maxun robots scrape <url> [options]

Option	Description
`-n, --name <name>`	Robot name
`-f, --format <fmt>`	Output formats: `markdown`, `html`, `text`, `screenshot-visible`, `screenshot-fullpage` (comma-separated, default: `markdown`)

Example:

maxun robots scrape https://example.com -f markdown,text -n "Example Scraper"

Create a multi-page crawler robot.

maxun robots crawl <url> [options]

Option	Description
`-n, --name <name>`	Robot name
`-f, --format <fmt>`	Output formats (comma-separated, default: `markdown`)
`--limit <n>`	Max pages to crawl (default: 10)
`--include <paths>`	Include path patterns (comma-separated)
`--exclude <paths>`	Exclude path patterns (comma-separated)

Example:

maxun robots crawl https://docs.example.com --limit 20 --include "/docs/*" -n "Docs Crawler"

Create a search-based robot.

maxun robots search <query> [options]

Option	Description
`-n, --name <name>`	Robot name
`-f, --format <fmt>`	Output formats (comma-separated)
`--limit <n>`	Max search results (default: 10)
`--mode <mode>`	`discover` (URLs + metadata) or `scrape` (full content, default: `discover`)

Example:

maxun robots search "Latest AI news" --mode discover --limit 10 -n "AI News"

Command	Description
`maxun robots get <id>`	Get details for a specific robot
`maxun robots delete <id>`	Delete a robot
`maxun robots duplicate <id> --url <new-url>`	Duplicate a robot with a different target URL