CLI
Sitemap
Sitemap crawl operations
Sitemap crawl operations
sitemap › create
Start a sitemap crawl
| Option | Description |
|---|---|
--url <url> | Root URL to crawl |
--strategy <strategy> | Crawl strategy: quick, standard, deep (omitted → server default standard) |
--max-depth <n> | Maximum crawl depth 1-5 (omitted → server default 2) |
--max-urls <n> | Maximum URLs to collect (omitted → server default 5000) |
--webhook-url <url> | HTTPS webhook URL notified when the crawl completes (omitted → poll-only, no delivery) |
--webhook-secret <secret> | HMAC secret used to sign the completion webhook (omitted → unsigned) |
--cache-ttl <ttl> | Cache freshness: 0, Nh (hours), or Nd (days), e.g. 48h, 30d, 0 (omitted → server default 30d; max 90d, enforced server-side) |
--compact | Return a compact result payload (omitted → server default off) |
--process <json> | Post-crawl processing directive as a JSON object, e.g. '{"action":"summarize"}' (omitted → none) |
--metadata <json> | Arbitrary metadata echoed on the job envelope, as a JSON object, e.g. '{"run":"7"}' (omitted → none) |
-h, --help | display help for command |
$ bytekit sitemap create --url <url> --strategy <strategy> --max-depth <n> --max-urls <n> --webhook-url <url> --webhook-secret <secret> --cache-ttl <ttl> --compact --process <json> --metadata <json>sitemap › get
Get a sitemap job by ID
| Option | Description |
|---|---|
-h, --help | display help for command |
$ bytekit sitemap get <id>