Skip to content
Analog Docs

CLI reference

Use this page to look up command names, option spellings, accepted values, and numeric bounds. Run analog <command> --help for the detailed behavior and examples attached to any command.

analog signup

Section titled “analog signup”
analog signup [OPTIONS] [CODE]

analog login

Section titled “analog login”
analog login [OPTIONS]

Options: --no-browser.

analog logout

Section titled “analog logout”
analog logout [OPTIONS]

analog whoami

Section titled “analog whoami”
analog whoami [OPTIONS]

Options: --verify / --no-verify.

analog status

Section titled “analog status”
analog status [OPTIONS]

analog doctor

Section titled “analog doctor”
analog doctor [OPTIONS]

analog feedback

Section titled “analog feedback”
analog feedback [OPTIONS] COMMAND [ARGS]...

Subcommands: analog feedback quality, analog feedback request.

analog feedback quality

Section titled “analog feedback quality”
analog feedback quality [OPTIONS] URL

Options: --reason, --note.

Static domains:

  • --reason — one of undetected_block, under_rendered, no_records_found, poor_field_naming, misfielded_values, page_chrome_in_records, over_extraction, under_extraction, wrong_content_extracted, garbled_markdown, other; required; repeatable.

analog feedback request

Section titled “analog feedback request”
analog feedback request [OPTIONS] TEXT

analog keys

Section titled “analog keys”
analog keys [OPTIONS] COMMAND [ARGS]...

Subcommands: analog keys list, analog keys revoke.

analog keys list

Section titled “analog keys list”
analog keys list [OPTIONS]

analog keys revoke

Section titled “analog keys revoke”
analog keys revoke [OPTIONS] PREFIX

analog get

Section titled “analog get”
analog get [OPTIONS] URL

Options: --markdown, --json, --headed, --no-reveal-all, --load-all, --expand-all, --pages, --mode, --no-save, --complete, --allow-private.

Static domains:

  • --pages — integer; 1–50; default 1.
  • --mode — one of auto, structured, local; default "auto".

analog assess

Section titled “analog assess”
analog assess [OPTIONS] URL

Options: --no-reveal-all, --load-all, --expand-all, --no-probe, --allow-private.

analog browser

Section titled “analog browser”
analog browser [OPTIONS] COMMAND [ARGS]...

Subcommands: analog browser install.

analog browser install

Section titled “analog browser install”
analog browser install [OPTIONS]

analog update

Section titled “analog update”
analog update [OPTIONS]

Options: --print.

analog history

Section titled “analog history”
analog history [OPTIONS]

Options: --usage, -v / --verbose, --json.

analog open

Section titled “analog open”
analog open [OPTIONS] REF

Options: --markdown, --json, --complete.

analog describe

Section titled “analog describe”
analog describe [OPTIONS] REF

Options: --format / -f, --section, --kind.

Static domains:

  • --format / -f — one of rich, markdown, plain, json; default "rich".

analog distinct

Section titled “analog distinct”
analog distinct [OPTIONS] REF FIELD

Options: --section, --kind, --json, --count / -c.

analog diff

Section titled “analog diff”
analog diff [OPTIONS] REF_A REF_B

Options: --section, --kind.

analog export

Section titled “analog export”
analog export [OPTIONS] REF

Options: --format / -f, --fields, --where, --sort, --desc, --limit, --section, --kind, --collection, --envelope, --output / -o.

Static domains:

  • --format / -f — one of json, csv, yaml, md, markdown; default "json".
  • --where — repeatable.
  • --limit — integer; at least 0.
  • --output / -o — file path.

analog find

Section titled “analog find”
analog find [OPTIONS] REF PATTERN

Options: --field, --regex, --json.

analog rm

Section titled “analog rm”
analog rm [OPTIONS] [REF]

Options: --all, --older-than, --url-contains, --dry-run.

analog rename

Section titled “analog rename”
analog rename [OPTIONS] REF NAME

analog rename-fields

Section titled “analog rename-fields”
analog rename-fields [OPTIONS] REF OLD=NEW...

Options: --once.

Static domains:

  • RENAMES — repeatable.

analog reorder-fields

Section titled “analog reorder-fields”
analog reorder-fields [OPTIONS] REF FIELD...

Options: --once.

Static domains:

  • FIELDS — repeatable.

analog help

Section titled “analog help”
analog help [OPTIONS] [COMMAND]...

Static domains:

  • COMMAND_PATH — repeatable.

analog quickstart

Section titled “analog quickstart”
analog quickstart [OPTIONS]

analog docs

Section titled “analog docs”
analog docs [OPTIONS]

analog contact

Section titled “analog contact”
analog contact [OPTIONS]