vf document preview-sitemap

vf document preview-sitemap: preview sitemap URLs. Requires --project-id and --sitemap-url, with a worked example.

Last updated Oct 19, 2026

Read a sitemap and return the URLs an import would create documents for.

Usage

vf document preview-sitemap [flags]

Examples

  vf document preview-sitemap --project-id <id> --sitemap-url https://fake-marimba.org

Flags

      --body string           Request body as JSON (alternative to individual flags). Can also be provided via stdin.
  -e, --exclude stringArray   Patterns that drop a URL from the import when any one of them matches. Matching is case-insensitive and unanchored: a pattern with no '*' matches any URL containing it as a substring ('/blog/'), while '*' matches any run of characters ('*/tag/*', '*.pdf').
  -h, --help                  help for preview-sitemap
  -p, --project-id string     [required]
  -s, --sitemap-url string    The HTTPS URL of the sitemap to read. A bare site URL works too — when it does not end in '.xml', '/sitemap.xml', '/sitemap_index.xml' and '/sitemap/sitemap.xml' are probed in turn. [required]

Global flags

These flags are inherited from the parent command and work on every invocation.

      --agent-mode             Enable structured errors and default TOON output for AI coding agents. Automatically enabled when a known agent environment is detected (CLAUDE_CODE, CURSOR_AGENT, etc.). Use --agent-mode=false to disable.
      --color string           Control colored output: auto (color when output is a TTY), always, or never. Respects NO_COLOR and FORCE_COLOR env vars. (default "auto")
  -d, --debug                  Log request and response diagnostics to stderr
      --dry-run                Preview the request that would be sent without executing it (output to stderr)
  -H, --header stringArray     Set a custom HTTP request header (format: "Key: Value"). Can be specified multiple times.
      --include-headers        Include HTTP response headers in the output
  -q, --jq string              Filter and transform output using a jq expression (e.g., '.name', '.items[] | .id')
      --no-interactive         Disable all interactive features (auto-prompting, explorer auto-launch, TUI forms)
  -o, --output-format string   Specify the output format. Options: pretty, json, yaml, table, toon. (default "pretty")
      --server-url string      Override the default server URL
      --timeout string         HTTP request timeout (e.g., 30s, 5m, 100ms)
      --token string           Voiceflow bearer token
      --usage                  Print the CLI Usage schema in KDL format

See also

vf document - Operations for document