Free My ID
Download

Command line reference

Commands and options registered in the Free My ID command line, with source lines for each entry.

Common options

Use --help to see the options for a command. The root command also provides these options. (Source: Source: src/freemyid/cli.py:21; root options are listed with their declarations.)

  • --help — Show this message and exit. (Source: src/freemyid/cli.py:21)
  • --verbose, -v (Source: src/freemyid/cli.py:138)
  • --install-completion — Install completion for the current shell. (Source: src/freemyid/cli.py:21)
  • --show-completion — Show completion for the current shell, to copy it or customize the installation. (Source: src/freemyid/cli.py:21)

Commands

The command names, short descriptions, arguments, and options below come from the registered CLI tree. (CLI app: Source: src/freemyid/cli.py:21; each entry has its own source line.)

freemyid setup

Walk through setup for a person (opens the local web wizard by default). (Source: src/freemyid/cli.py:160)

Command source: src/freemyid/cli.py:147

Options

  • --prefill PREFILL — Family bundle (.freemyid-profile) (Source: src/freemyid/cli.py:148)
  • --web, --no-web — Open the web wizard (else terminal prompts; --prefill implies terminal) (Source: src/freemyid/cli.py:150)
  • --from FROM_FILE — Set up from a YAML file, no wizard (docs/CLI.md) (Source: src/freemyid/cli.py:152)
  • --yes — With --from: confirm without asking (Source: src/freemyid/cli.py:154)
  • --check — With --from: validate and show the plan; save nothing (Source: src/freemyid/cli.py:156)
  • --update — With --from: replace the person with the same label (Source: src/freemyid/cli.py:158)

freemyid doctor

Check this computer is ready: Python, data folder, secrets, browser, schedule, mail. (Source: src/freemyid/cli.py:183)

Command source: src/freemyid/cli.py:179

Options

  • --offline — Skip the mail server reachability check (Source: src/freemyid/cli.py:180)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:182)

freemyid app

Open Free My ID in its own window (wizard on first launch, dashboard after). (Source: src/freemyid/cli.py:245)

Command source: src/freemyid/cli.py:242

Options

  • --no-window — Use the web browser instead of an app window (Source: src/freemyid/cli.py:243)

freemyid dashboard

Open the local dashboard (status, evidence, to-dos, approvals). (Source: src/freemyid/cli.py:252)

Command source: src/freemyid/cli.py:250

No arguments or command-specific options are declared. (Source: src/freemyid/cli.py:250)

freemyid scan

Search brokers for listings. Never submits anything. (Source: src/freemyid/cli.py:341)

Command source: src/freemyid/cli.py:335

Options

  • --profile, -p PROFILE (Source: src/freemyid/cli.py:336)
  • --broker, -b BROKER (Source: src/freemyid/cli.py:337)
  • --headless — No prompts or windows; fail closed (cron/Docker) (Source: src/freemyid/cli.py:338)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:340)

freemyid run

Scan, submit opt-outs, check verifications and escalate ignored requests. (Source: src/freemyid/cli.py:356)

Command source: src/freemyid/cli.py:346

Options

  • --profile, -p PROFILE (Source: src/freemyid/cli.py:347)
  • --broker, -b BROKER (Source: src/freemyid/cli.py:348)
  • --dry-run — Search + report, submit nothing (Source: src/freemyid/cli.py:349)
  • --headless — No prompts or windows; fail closed (cron/systemd/Docker) (Source: src/freemyid/cli.py:351)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:354)
  • --scheduled (Source: src/freemyid/cli.py:355)

freemyid fill

Open the broker's form in a visible window and fill it in; you tick the box and Submit. (Source: src/freemyid/cli.py:365)

Command source: src/freemyid/cli.py:361

Arguments

  • broker (required) (Source: src/freemyid/cli.py:362)

Options

  • --profile, -p PROFILE (Source: src/freemyid/cli.py:363)
  • --timeout TIMEOUT (Source: src/freemyid/cli.py:364)

freemyid status

Per-broker status for each person. (Source: src/freemyid/cli.py:382)

Command source: src/freemyid/cli.py:379

Options

  • --profile, -p PROFILE (Source: src/freemyid/cli.py:380)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:381)

freemyid exposure

Find me first: which people-search sites show you, with a 0-100 exposure score. (Source: src/freemyid/cli.py:423)

Command source: src/freemyid/cli.py:409

Options

  • --profile, -p PROFILE (Source: src/freemyid/cli.py:410)
  • --offline — Fetch nothing; use what earlier runs found (Source: src/freemyid/cli.py:411)
  • --refresh — Check every site again, even if checked today (Source: src/freemyid/cli.py:413)
  • --old-addresses — Also search each site once at your previous address (off by default; at most one extra page per site) (Source: src/freemyid/cli.py:415)
  • --headless — No prompts or windows; fail closed (cron/Docker) (Source: src/freemyid/cli.py:419)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:422)

freemyid report

Export a report (HTML or PDF). (Source: src/freemyid/cli.py:516)

Command source: src/freemyid/cli.py:512

Options

  • --profile, -p PROFILE (Source: src/freemyid/cli.py:513)
  • --format FMT — html | pdf (Source: src/freemyid/cli.py:514)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:515)

freemyid wipe

Delete everything Free My ID saved on this computer: people, evidence, mailbox passwords, (Source: src/freemyid/cli.py:583)

Command source: src/freemyid/cli.py:581

Options

  • --yes (Source: src/freemyid/cli.py:582)

freemyid search-engines

Google and Bing: guided steps to ask them to stop showing pages about you. (Source: src/freemyid/cli.py:910)

Command source: src/freemyid/cli.py:903

Arguments

  • action (optional) (Source: src/freemyid/cli.py:905)
  • step_id (optional) (Source: src/freemyid/cli.py:907)

Options

  • --profile, -p PROFILE — Whose list (needed only when more than one person is set up) (Source: src/freemyid/cli.py:909)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:909)

freemyid profile add

Command source: src/freemyid/cli.py:536

Options

  • --prefill PREFILL (Source: src/freemyid/cli.py:537)

freemyid profile list

Everyone set up on this computer. (Source: src/freemyid/cli.py:543)

Command source: src/freemyid/cli.py:541

Options

  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:542)

freemyid profile edit

Command source: src/freemyid/cli.py:558

Arguments

  • profile (required) (Source: src/freemyid/cli.py:559)

freemyid profile remove

Delete a person and all their stored data from this computer. (Source: src/freemyid/cli.py:568)

Command source: src/freemyid/cli.py:566

Arguments

  • profile (required) (Source: src/freemyid/cli.py:567)

Options

  • --yes (Source: src/freemyid/cli.py:567)

freemyid profile export

Create a passphrase-protected pre-filled profile for a family installer. (Source: src/freemyid/cli.py:633)

Command source: src/freemyid/cli.py:631

Arguments

  • profile (required) (Source: src/freemyid/cli.py:632)
  • dest (required) (Source: src/freemyid/cli.py:632)

freemyid schedule install

Command source: src/freemyid/cli.py:645

No arguments or command-specific options are declared. (Source: src/freemyid/cli.py:645)

freemyid schedule remove

Command source: src/freemyid/cli.py:651

No arguments or command-specific options are declared. (Source: src/freemyid/cli.py:651)

freemyid schedule status

Command source: src/freemyid/cli.py:657

Options

  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:658)

freemyid registry update

Command source: src/freemyid/cli.py:674

No arguments or command-specific options are declared. (Source: src/freemyid/cli.py:674)

freemyid registry validate

Command source: src/freemyid/cli.py:681

Arguments

  • path (optional) (Source: src/freemyid/cli.py:682)

freemyid registry source

Which broker list is in use: update, family, full or sample. (Source: src/freemyid/cli.py:692)

Command source: src/freemyid/cli.py:689

Options

  • --plain (Source: src/freemyid/cli.py:690)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:691)

freemyid registry show

Every broker in the registry in use, highest priority first. (Source: src/freemyid/cli.py:708)

Command source: src/freemyid/cli.py:706

Options

  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:707)

freemyid todo list

Open to-dos (things that need a person). (Source: src/freemyid/cli.py:729)

Command source: src/freemyid/cli.py:726

Options

  • --profile, -p PROFILE (Source: src/freemyid/cli.py:727)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:728)

freemyid todo done

Command source: src/freemyid/cli.py:741

Arguments

  • todo_id (required) (Source: src/freemyid/cli.py:742)

freemyid outbox list

Emails waiting for your approval. (Source: src/freemyid/cli.py:752)

Command source: src/freemyid/cli.py:750

Options

  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:751)

freemyid outbox approve

Command source: src/freemyid/cli.py:763

Arguments

  • request_id (required) (Source: src/freemyid/cli.py:764)

freemyid config set

Command source: src/freemyid/cli.py:1021

Arguments

  • key (required) (Source: src/freemyid/cli.py:1022)
  • value (required) (Source: src/freemyid/cli.py:1022)

freemyid config enable-submissions

One-time explicit opt-in to real (non-dry-run) opt-out submissions. (Source: src/freemyid/cli.py:1043)

Command source: src/freemyid/cli.py:1041

No arguments or command-specific options are declared. (Source: src/freemyid/cli.py:1041)

freemyid secrets status

Which backend holds the encryption key (keyring, passphrase or systemd-creds). (Source: src/freemyid/cli.py:974)

Command source: src/freemyid/cli.py:972

Options

  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:973)

freemyid secrets migrate

Move the encryption key (and saved mailbox passwords) to another backend. (Source: src/freemyid/cli.py:996)

Command source: src/freemyid/cli.py:988

Options

  • --to TO (required) — passphrase | keyring | systemd-creds (Source: src/freemyid/cli.py:990)
  • --remove-keychain-key — Also delete the key from the system keychain. Only if this is the ONLY Free My ID folder on this computer: other folders that use the keychain share that key and would lose their data. (Source: src/freemyid/cli.py:991)

freemyid checklist list

Every checklist, and which ones are done. (Source: src/freemyid/cli.py:817)

Command source: src/freemyid/cli.py:815

Options

  • --profile, -p PROFILE — Whose list (needed only when more than one person is set up) (Source: src/freemyid/cli.py:816)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:816)

freemyid checklist show

The steps for one checklist. (Source: src/freemyid/cli.py:843)

Command source: src/freemyid/cli.py:840

Arguments

  • checklist_id (required) (Source: src/freemyid/cli.py:841)

Options

  • --profile, -p PROFILE — Whose list (needed only when more than one person is set up) (Source: src/freemyid/cli.py:842)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:842)

freemyid checklist done

Mark a checklist as done. (Source: src/freemyid/cli.py:882)

Command source: src/freemyid/cli.py:879

Arguments

  • checklist_id (required) (Source: src/freemyid/cli.py:880)

Options

  • --profile, -p PROFILE — Whose list (needed only when more than one person is set up) (Source: src/freemyid/cli.py:881)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:881)

freemyid checklist undo

Mark a checklist as not done again. (Source: src/freemyid/cli.py:889)

Command source: src/freemyid/cli.py:886

Arguments

  • checklist_id (required) (Source: src/freemyid/cli.py:887)

Options

  • --profile, -p PROFILE — Whose list (needed only when more than one person is set up) (Source: src/freemyid/cli.py:888)
  • --json — Machine-readable output (docs/CLI.md) (Source: src/freemyid/cli.py:888)