# Command flags

Every flag both Ptah binaries register, with its type, default and environment variable.

Source: https://docs.ptah.run/v0.8.0/reference/command-flags/

<!-- Generated by internal/cmd/cmdref. Do not edit by hand: run `scripts/check-docsync.sh --write`. -->

The command trees of the two shipped binaries supply one row per command and
flag. The inventory records which spellings a command accepts,
what each holds when nothing sets it, and which variable it reads. For a
flag's own words run `ptah <command> --help`, which prints the same usage
string this page indexes by name. What each VERB is for is on
[Native commands](../native-commands/) and
[Atlas-compatible commands](../atlas-commands/).

Each flag table sits under the exact command path that accepts it. The
command path is outside the table so the five measured flag fields fit the
documentation column without hiding the right-hand fields.

Read the columns as follows.

- **Default** is the value the flag holds when nothing sets one, in the
  spelling the flag parser reports.
- **Environment variable** is what the flag reads when it is not typed on the
  command line, and an em dash means it reads none. Approval is where the
  column earns its place: no `--auto-approve` and no
  `--allow-database-inspect` the native binary registers reads a variable, so
  nothing a script exports can approve a `ptah` run. That is a rule about the
  native surface rather than about the spelling — the compatibility
  surface's `ptah-compat schema plan` verbs do bind one — so read the row
  rather than the flag name.
- **Notes** carries `hidden` for a flag `--help` does not list and still
  parses, and `inherited by subcommands` for one declared on a group.

<div class="ptah-reference-filter" data-mode="all-tables">
  <label for="command-flag-filter">Filter commands and flags <input id="command-flag-filter" type="search" placeholder="db-url, schema apply…" /></label>
  <p data-ptah-filter-status role="status" aria-live="polite"></p>
</div>

## `ptah`

**`ptah assist`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-database-inspect` | `string` | — | — | — |
| `--allow-write` | `stringSlice` | `[]` | `PTAH_ALLOW_WRITE` | — |
| `--audit-log` | `string` | — | `PTAH_AUDIT_LOG` | — |
| `--auto-approve` | `bool` | `false` | — | — |
| `--database-class` | `string` | — | `PTAH_DATABASE_CLASS` | — |
| `--database-name` | `string` | — | `PTAH_DATABASE_NAME` | — |
| `--database-url` | `string` | — | `PTAH_DATABASE_URL` | — |
| `--dialect` | `string` | — | `PTAH_DIALECT` | — |
| `--ephemeral` | `bool` | `false` | `PTAH_EPHEMERAL` | — |
| `--max-tool-calls` | `int` | `40` | `PTAH_MAX_TOOL_CALLS` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--model` | `string` | — | `PTAH_MODEL` | — |
| `--provider-profile` | `string` | — | `PTAH_PROVIDER_PROFILE` | — |
| `--resume` | `string` | — | `PTAH_RESUME` | — |
| `--schema-dir` | `string` | — | `PTAH_SCHEMA_DIR` | — |
| `--schema-source-root` | `stringSlice` | `[]` | `PTAH_SCHEMA_SOURCE_ROOT` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--tests-dir` | `string` | — | `PTAH_TESTS_DIR` | — |
| `--trace` | `bool` | `false` | `PTAH_TRACE` | — |
| `--workspace` | `string` | — | `PTAH_WORKSPACE` | — |

</div>

**`ptah assist context`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-database-inspect` | `string` | — | — | — |
| `--allow-write` | `stringSlice` | `[]` | `PTAH_ALLOW_WRITE` | — |
| `--audit-log` | `string` | — | `PTAH_AUDIT_LOG` | — |
| `--auto-approve` | `bool` | `false` | — | — |
| `--database-class` | `string` | — | `PTAH_DATABASE_CLASS` | — |
| `--database-name` | `string` | — | `PTAH_DATABASE_NAME` | — |
| `--database-url` | `string` | — | `PTAH_DATABASE_URL` | — |
| `--dialect` | `string` | — | `PTAH_DIALECT` | — |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--model` | `string` | — | `PTAH_MODEL` | — |
| `--provider-profile` | `string` | — | `PTAH_PROVIDER_PROFILE` | — |
| `--resume` | `string` | — | `PTAH_RESUME` | — |
| `--schema-dir` | `string` | — | `PTAH_SCHEMA_DIR` | — |
| `--schema-source-root` | `stringSlice` | `[]` | `PTAH_SCHEMA_SOURCE_ROOT` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--tests-dir` | `string` | — | `PTAH_TESTS_DIR` | — |
| `--workspace` | `string` | — | `PTAH_WORKSPACE` | — |

</div>

**`ptah assist explain`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-database-inspect` | `string` | — | — | — |
| `--allow-write` | `stringSlice` | `[]` | `PTAH_ALLOW_WRITE` | — |
| `--audit-log` | `string` | — | `PTAH_AUDIT_LOG` | — |
| `--auto-approve` | `bool` | `false` | — | — |
| `--database-class` | `string` | — | `PTAH_DATABASE_CLASS` | — |
| `--database-name` | `string` | — | `PTAH_DATABASE_NAME` | — |
| `--database-url` | `string` | — | `PTAH_DATABASE_URL` | — |
| `--dialect` | `string` | — | `PTAH_DIALECT` | — |
| `--ephemeral` | `bool` | `false` | `PTAH_EPHEMERAL` | — |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--max-tool-calls` | `int` | `40` | `PTAH_MAX_TOOL_CALLS` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--model` | `string` | — | `PTAH_MODEL` | — |
| `--non-interactive` | `bool` | `false` | `PTAH_NON_INTERACTIVE` | — |
| `--provider-profile` | `string` | — | `PTAH_PROVIDER_PROFILE` | — |
| `--resume` | `string` | — | `PTAH_RESUME` | — |
| `--schema-dir` | `string` | — | `PTAH_SCHEMA_DIR` | — |
| `--schema-source-root` | `stringSlice` | `[]` | `PTAH_SCHEMA_SOURCE_ROOT` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--tests-dir` | `string` | — | `PTAH_TESTS_DIR` | — |
| `--trace` | `bool` | `false` | `PTAH_TRACE` | — |
| `--workspace` | `string` | — | `PTAH_WORKSPACE` | — |

</div>

**`ptah assist provider list`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |

</div>

**`ptah assist provider test`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--model` | `string` | — | `PTAH_MODEL` | — |
| `--provider-profile` | `string` | — | `PTAH_PROVIDER_PROFILE` | — |

</div>

**`ptah assist sessions delete`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--workspace` | `string` | — | `PTAH_WORKSPACE` | — |

</div>

**`ptah assist sessions list`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--workspace` | `string` | — | `PTAH_WORKSPACE` | — |

</div>

**`ptah assist sessions prune`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--older-than` | `duration` | `720h0m0s` | `PTAH_OLDER_THAN` | — |
| `--workspace` | `string` | — | `PTAH_WORKSPACE` | — |

</div>

**`ptah assist sessions show`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--workspace` | `string` | — | `PTAH_WORKSPACE` | — |

</div>

**`ptah completion bash`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--no-descriptions` | `bool` | `false` | — | — |

</div>

**`ptah completion fish`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--no-descriptions` | `bool` | `false` | — | — |

</div>

**`ptah completion powershell`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--no-descriptions` | `bool` | `false` | — | — |

</div>

**`ptah completion zsh`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--no-descriptions` | `bool` | `false` | — | — |

</div>

**`ptah db capabilities`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |

</div>

**`ptah db drop-all`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--auto-approve` | `bool` | `false` | — | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |

</div>

**`ptah db read`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |

</div>

**`ptah db verify`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--checks` | `string` | — | `PTAH_CHECKS` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |

</div>

**`ptah inference abandon`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--reason` | `string` | — | `PTAH_REASON` | — |
| `--run-id` | `string` | — | `PTAH_RUN_ID` | — |

</div>

**`ptah inference backfill`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--batch-inputs` | `int` | `32` | `PTAH_BATCH_INPUTS` | — |
| `--batch-rows` | `int` | `200` | `PTAH_BATCH_ROWS` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--provider-timeout` | `duration` | `1m0s` | `PTAH_PROVIDER_TIMEOUT` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--run-id` | `string` | — | `PTAH_RUN_ID` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |

</div>

**`ptah inference catchup`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--batch-inputs` | `int` | `32` | `PTAH_BATCH_INPUTS` | — |
| `--batch-rows` | `int` | `200` | `PTAH_BATCH_ROWS` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--maintain-for` | `duration` | `0s` | `PTAH_MAINTAIN_FOR` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--provider-timeout` | `duration` | `1m0s` | `PTAH_PROVIDER_TIMEOUT` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--run-id` | `string` | — | `PTAH_RUN_ID` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |

</div>

**`ptah inference cutover`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--accept-finding` | `stringArray` | `[]` | `PTAH_ACCEPT_FINDING` | — |
| `--allowed-signers` | `string` | — | `PTAH_ALLOWED_SIGNERS` | — |
| `--approval` | `string` | — | `PTAH_APPROVAL` | — |
| `--approve` | `string` | — | `PTAH_APPROVE` | — |
| `--approver` | `string` | — | `PTAH_APPROVER` | — |
| `--attach-to` | `string` | — | `PTAH_ATTACH_TO` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--evidence-file` | `string` | — | `PTAH_EVIDENCE_FILE` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--plan-file` | `string` | — | `PTAH_PLAN_FILE` | — |
| `--publish-evidence` | `string` | — | `PTAH_PUBLISH_EVIDENCE` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--run-id` | `string` | — | `PTAH_RUN_ID` | — |
| `--signer` | `string` | — | `PTAH_SIGNER` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |
| `--stabilize-for` | `duration` | `0s` | `PTAH_STABILIZE_FOR` | — |

</div>

**`ptah inference describe`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |

</div>

**`ptah inference evaluate`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--baseline` | `string` | — | `PTAH_BASELINE` | — |
| `--baseline-spec` | `string` | — | `PTAH_BASELINE_SPEC` | — |
| `--corpus` | `string` | — | `PTAH_CORPUS` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--k` | `int` | `10` | `PTAH_K` | — |
| `--max-mrr-regression` | `float64` | `0` | `PTAH_MAX_MRR_REGRESSION` | — |
| `--max-ndcg-regression` | `float64` | `0` | `PTAH_MAX_NDCG_REGRESSION` | — |
| `--min-exact-agreement` | `float64` | `0` | `PTAH_MIN_EXACT_AGREEMENT` | — |
| `--min-recall` | `float64` | `0` | `PTAH_MIN_RECALL` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--provider-timeout` | `duration` | `1m0s` | `PTAH_PROVIDER_TIMEOUT` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--require-every-case` | `bool` | `true` | `PTAH_REQUIRE_EVERY_CASE` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |

</div>

**`ptah inference index`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--run-id` | `string` | — | `PTAH_RUN_ID` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |

</div>

**`ptah inference pause`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--reason` | `string` | — | `PTAH_REASON` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--run-id` | `string` | — | `PTAH_RUN_ID` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |
| `--worker` | `string` | `ptah-cli` | `PTAH_WORKER` | — |

</div>

**`ptah inference plan`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--current` | `string` | — | `PTAH_CURRENT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--evidence-file` | `string` | — | `PTAH_EVIDENCE_FILE` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--publish-evidence` | `string` | — | `PTAH_PUBLISH_EVIDENCE` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |

</div>

**`ptah inference prepare`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--run-id` | `string` | — | `PTAH_RUN_ID` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |
| `--worker` | `string` | `ptah-cli` | `PTAH_WORKER` | — |

</div>

**`ptah inference probe`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--provider-timeout` | `duration` | `30s` | `PTAH_PROVIDER_TIMEOUT` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |

</div>

**`ptah inference resume`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--run-id` | `string` | — | `PTAH_RUN_ID` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |
| `--worker` | `string` | `ptah-cli` | `PTAH_WORKER` | — |

</div>

**`ptah inference retire`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allowed-signers` | `string` | — | `PTAH_ALLOWED_SIGNERS` | — |
| `--approval` | `string` | — | `PTAH_APPROVAL` | — |
| `--approve` | `string` | — | `PTAH_APPROVE` | — |
| `--approver` | `string` | — | `PTAH_APPROVER` | — |
| `--attach-to` | `string` | — | `PTAH_ATTACH_TO` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--drop-column` | `bool` | `true` | `PTAH_DROP_COLUMN` | — |
| `--evidence-file` | `string` | — | `PTAH_EVIDENCE_FILE` | — |
| `--generation` | `string` | — | `PTAH_GENERATION` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--plan-file` | `string` | — | `PTAH_PLAN_FILE` | — |
| `--publish-evidence` | `string` | — | `PTAH_PUBLISH_EVIDENCE` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--signer` | `string` | — | `PTAH_SIGNER` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |

</div>

**`ptah inference rollback`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--attach-to` | `string` | — | `PTAH_ATTACH_TO` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--evidence-file` | `string` | — | `PTAH_EVIDENCE_FILE` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--publish-evidence` | `string` | — | `PTAH_PUBLISH_EVIDENCE` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |
| `--to` | `string` | — | `PTAH_TO` | — |
| `--window` | `duration` | `0s` | `PTAH_WINDOW` | — |

</div>

**`ptah inference status`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--require-ready` | `bool` | `false` | `PTAH_REQUIRE_READY` | — |
| `--run-id` | `string` | — | `PTAH_RUN_ID` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |

</div>

**`ptah inference verify`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--attach-to` | `string` | — | `PTAH_ATTACH_TO` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--evidence-file` | `string` | — | `PTAH_EVIDENCE_FILE` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--publish-evidence` | `string` | — | `PTAH_PUBLISH_EVIDENCE` | — |
| `--release` | `string` | — | `PTAH_RELEASE` | — |
| `--run-id` | `string` | — | `PTAH_RUN_ID` | — |
| `--spec` | `string` | — | `PTAH_SPEC` | — |

</div>

**`ptah introspect`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--add-db-tags` | `bool` | `false` | `PTAH_ADD_DB_TAGS` | — |
| `--add-json-tags` | `bool` | `false` | `PTAH_ADD_JSON_TAGS` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--lowercase-fields` | `bool` | `false` | `PTAH_LOWERCASE_FIELDS` | — |
| `--out` | `string` | — | `PTAH_OUT` | — |
| `--package` | `string` | `models` | `PTAH_PACKAGE` | — |
| `--per-table` | `bool` | `false` | `PTAH_PER_TABLE` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--single-file` | `bool` | `false` | `PTAH_SINGLE_FILE` | — |

</div>

**`ptah mcp`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-database-inspect` | `string` | — | — | — |
| `--allow-write` | `stringSlice` | `[]` | `PTAH_ALLOW_WRITE` | — |
| `--audit-log` | `string` | — | `PTAH_AUDIT_LOG` | — |
| `--auto-approve` | `bool` | `false` | — | — |
| `--database-class` | `string` | — | `PTAH_DATABASE_CLASS` | — |
| `--database-name` | `string` | — | `PTAH_DATABASE_NAME` | — |
| `--database-url` | `string` | — | `PTAH_DATABASE_URL` | — |
| `--dialect` | `string` | — | `PTAH_DIALECT` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--schema-dir` | `string` | — | `PTAH_SCHEMA_DIR` | — |
| `--schema-source-root` | `stringSlice` | `[]` | `PTAH_SCHEMA_SOURCE_ROOT` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--tests-dir` | `string` | — | `PTAH_TESTS_DIR` | — |
| `--workspace` | `string` | — | `PTAH_WORKSPACE` | — |

</div>

**`ptah migrations baseline`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--atlas-env` | `string` | — | `PTAH_ATLAS_ENV` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--force` | `bool` | `false` | `PTAH_FORCE` | — |
| `--migration-lock-timeout` | `string` | — | `PTAH_MIGRATION_LOCK_TIMEOUT` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--migrations-engine` | `string` | — | `PTAH_MIGRATIONS_ENGINE` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--root-dir` | `string` | `./` | `PTAH_ROOT_DIR` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--shadow-db` | `string` | — | `PTAH_SHADOW_DB` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah migrations checkpoint`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--data-table` | `stringArray` | `[]` | `PTAH_DATA_TABLE` | — |
| `--description` | `string` | `checkpoint` | `PTAH_DESCRIPTION` | — |
| `--dialect` | `string` | — | `PTAH_DIALECT` | — |
| `--dir-format` | `string` | `ptah` | `PTAH_DIR_FORMAT` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--edit` | `bool` | `false` | `PTAH_EDIT` | — |
| `--editor` | `string` | — | `PTAH_EDITOR` | — |
| `--migration-lock-timeout` | `string` | — | `PTAH_MIGRATION_LOCK_TIMEOUT` | — |
| `--migrations-dir` | `string` | `./migrations` | `PTAH_MIGRATIONS_DIR` | — |
| `--qualifier` | `string` | — | `PTAH_QUALIFIER` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--shadow-db` | `string` | — | `PTAH_SHADOW_DB` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah migrations create`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--edit` | `bool` | `false` | `PTAH_EDIT` | — |
| `--editor` | `string` | — | `PTAH_EDITOR` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--name` | `string` | — | `PTAH_NAME` | — |

</div>

**`ptah migrations data`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-destructive` | `bool` | `false` | `PTAH_ALLOW_DESTRUCTIVE` | — |
| `--allow-prod` | `bool` | `false` | `PTAH_ALLOW_PROD` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--description` | `string` | `data` | `PTAH_DESCRIPTION` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--migrations-dir` | `string` | `./migrations` | `PTAH_MIGRATIONS_DIR` | — |
| `--protected-table` | `stringArray` | `[]` | `PTAH_PROTECTED_TABLE` | — |
| `--root-dir` | `string` | — | `PTAH_ROOT_DIR` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah migrations down`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--actor` | `string` | — | `PTAH_ACTOR` | — |
| `--atlas-env` | `string` | — | `PTAH_ATLAS_ENV` | — |
| `--atlas-project-config` | `string` | — | `PTAH_ATLAS_PROJECT_CONFIG` | hidden |
| `--atlas-project-var` | `stringArray` | `[]` | `PTAH_ATLAS_PROJECT_VAR` | hidden |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--confirm` | `bool` | `false` | `PTAH_CONFIRM` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--exec-order` | `string` | `linear` | `PTAH_EXEC_ORDER` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--log-format` | `string` | `text` | `PTAH_LOG_FORMAT` | — |
| `--log-level` | `string` | `info` | `PTAH_LOG_LEVEL` | — |
| `--metrics-addr` | `string` | — | `PTAH_METRICS_ADDR` | — |
| `--migration-lock-timeout` | `string` | — | `PTAH_MIGRATION_LOCK_TIMEOUT` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--migrations-engine` | `string` | — | `PTAH_MIGRATIONS_ENGINE` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--mysqldump-to` | `string` | — | `PTAH_MYSQLDUMP_TO` | — |
| `--pg-dump-to` | `string` | — | `PTAH_PG_DUMP_TO` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--plan` | `bool` | `false` | `PTAH_PLAN` | — |
| `--pre-down-hook` | `string` | — | `PTAH_PRE_DOWN_HOOK` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--shadow-db` | `string` | — | `PTAH_SHADOW_DB` | — |
| `--skip-checks` | `bool` | `false` | `PTAH_SKIP_CHECKS` | — |
| `--statement-timeout` | `string` | — | `PTAH_STATEMENT_TIMEOUT` | — |
| `--target` | `string` | `0` | `PTAH_TARGET` | — |
| `--to-tag` | `string` | — | `PTAH_TO_TAG` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |
| `--verbose` | `bool` | `false` | `PTAH_VERBOSE` | — |
| `--verify-sum` | `bool` | `false` | `PTAH_VERIFY_SUM` | — |
| `--webhook` | `string` | — | `PTAH_WEBHOOK` | — |

</div>

**`ptah migrations edit`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--atlas-env` | `string` | — | `PTAH_ATLAS_ENV` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--down-file` | `string` | — | `PTAH_DOWN_FILE` | — |
| `--editor` | `string` | — | `PTAH_EDITOR` | — |
| `--force` | `bool` | `false` | `PTAH_FORCE` | — |
| `--migrations-dir` | `string` | `./migrations` | `PTAH_MIGRATIONS_DIR` | — |
| `--migrations-engine` | `string` | — | `PTAH_MIGRATIONS_ENGINE` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--up-file` | `string` | — | `PTAH_UP_FILE` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah migrations generate`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-destructive` | `bool` | `false` | `PTAH_ALLOW_DESTRUCTIVE` | — |
| `--allow-external-schema` | `bool` | `false` | `PTAH_ALLOW_EXTERNAL_SCHEMA` | — |
| `--check-destructive` | `bool` | `false` | `PTAH_CHECK_DESTRUCTIVE` | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--ignore-extension` | `stringArray` | `[]` | `PTAH_IGNORE_EXTENSION` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--name` | `string` | `migration` | `PTAH_NAME` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--qualifier` | `string` | — | `PTAH_QUALIFIER` | — |
| `--replay` | `bool` | `false` | `PTAH_REPLAY` | — |
| `--report` | `string` | — | `PTAH_REPORT` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-cmd` | `string` | — | `PTAH_SCHEMA_CMD` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--schema-format` | `string` | `sql` | `PTAH_SCHEMA_FORMAT` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--shadow-db` | `string` | — | `PTAH_SHADOW_DB` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah migrations hash`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir` | `string` | `./migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |

</div>

**`ptah migrations import`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-partial` | `bool` | `false` | `PTAH_ALLOW_PARTIAL` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--from` | `string` | — | `PTAH_FROM` | — |
| `--migrations-dir` | `string` | `./migrations` | `PTAH_MIGRATIONS_DIR` | — |
| `--source-dir` | `string` | — | `PTAH_SOURCE_DIR` | — |

</div>

**`ptah migrations lint`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--atlas-env` | `string` | — | `PTAH_ATLAS_ENV` | — |
| `--atlas-project-config` | `string` | — | `PTAH_ATLAS_PROJECT_CONFIG` | hidden |
| `--atlas-project-var` | `stringArray` | `[]` | `PTAH_ATLAS_PROJECT_VAR` | hidden |
| `--attach` | `bool` | `false` | `PTAH_ATTACH` | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dialect` | `string` | — | `PTAH_DIALECT` | — |
| `--dir` | `string` | `./migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--disable` | `stringArray` | `[]` | `PTAH_DISABLE` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--fail-on` | `string` | `error` | `PTAH_FAIL_ON` | — |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--git-base` | `string` | — | `PTAH_GIT_BASE` | — |
| `--git-dir` | `string` | `.` | `PTAH_GIT_DIR` | — |
| `--latest` | `uint` | `0` | `PTAH_LATEST` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah migrations log`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--json` | `bool` | `false` | `PTAH_JSON` | — |
| `--limit` | `int` | `50` | `PTAH_LIMIT` | — |
| `--migrations-engine` | `string` | — | `PTAH_MIGRATIONS_ENGINE` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah migrations ls`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--latest` | `bool` | `false` | `PTAH_LATEST` | — |
| `--migrations-dir` | `string` | `./migrations` | `PTAH_MIGRATIONS_DIR` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--short` | `bool` | `false` | `PTAH_SHORT` | — |
| `--verify-sum` | `bool` | `false` | `PTAH_VERIFY_SUM` | — |

</div>

**`ptah migrations plan`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-destructive` | `bool` | `false` | `PTAH_ALLOW_DESTRUCTIVE` | — |
| `--allow-external-schema` | `bool` | `false` | `PTAH_ALLOW_EXTERNAL_SCHEMA` | — |
| `--attach` | `bool` | `false` | `PTAH_ATTACH` | — |
| `--check-destructive` | `bool` | `false` | `PTAH_CHECK_DESTRUCTIVE` | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--ignore-extension` | `stringArray` | `[]` | `PTAH_IGNORE_EXTENSION` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--report` | `string` | `text` | `PTAH_REPORT` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-cmd` | `string` | — | `PTAH_SCHEMA_CMD` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--schema-format` | `string` | `sql` | `PTAH_SCHEMA_FORMAT` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah migrations pull`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--out` | `string` | — | `PTAH_OUT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |

</div>

**`ptah migrations push`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--generated-version` | `bool` | `false` | `PTAH_GENERATED_VERSION` | — |
| `--latest` | `bool` | `false` | `PTAH_LATEST` | — |
| `--migrations-dir` | `string` | `./migrations` | `PTAH_MIGRATIONS_DIR` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--tag` | `stringArray` | `[]` | `PTAH_TAG` | — |
| `--verify-sum` | `bool` | `false` | `PTAH_VERIFY_SUM` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah migrations rebase`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--atlas-env` | `string` | — | `PTAH_ATLAS_ENV` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--force` | `bool` | `false` | `PTAH_FORCE` | — |
| `--migrations-dir` | `string` | `./migrations` | `PTAH_MIGRATIONS_DIR` | — |
| `--migrations-engine` | `string` | — | `PTAH_MIGRATIONS_ENGINE` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah migrations repair`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--atlas-env` | `string` | — | `PTAH_ATLAS_ENV` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--force` | `bool` | `false` | `PTAH_FORCE` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--migrations-engine` | `string` | — | `PTAH_MIGRATIONS_ENGINE` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--resume-from` | `string` | — | `PTAH_RESUME_FROM` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah migrations rm`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--atlas-env` | `string` | — | `PTAH_ATLAS_ENV` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--force` | `bool` | `false` | `PTAH_FORCE` | — |
| `--migrations-dir` | `string` | `./migrations` | `PTAH_MIGRATIONS_DIR` | — |
| `--migrations-engine` | `string` | — | `PTAH_MIGRATIONS_ENGINE` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah migrations set`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--atlas-env` | `string` | — | `PTAH_ATLAS_ENV` | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah migrations show`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--direction` | `string` | `up` | `PTAH_DIRECTION` | — |
| `--migrations-dir` | `string` | `./migrations` | `PTAH_MIGRATIONS_DIR` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--verify-sum` | `bool` | `false` | `PTAH_VERIFY_SUM` | — |
| `--version` | `stringArray` | `[]` | `PTAH_VERSION` | — |

</div>

**`ptah migrations status`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--atlas-env` | `string` | — | `PTAH_ATLAS_ENV` | — |
| `--atlas-project-config` | `string` | — | `PTAH_ATLAS_PROJECT_CONFIG` | hidden |
| `--atlas-project-var` | `stringArray` | `[]` | `PTAH_ATLAS_PROJECT_VAR` | hidden |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--exit-code` | `bool` | `false` | `PTAH_EXIT_CODE` | — |
| `--json` | `bool` | `false` | `PTAH_JSON` | — |
| `--log-format` | `string` | `text` | `PTAH_LOG_FORMAT` | — |
| `--log-level` | `string` | `info` | `PTAH_LOG_LEVEL` | — |
| `--metrics-addr` | `string` | — | `PTAH_METRICS_ADDR` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--migrations-engine` | `string` | — | `PTAH_MIGRATIONS_ENGINE` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |
| `--verbose` | `bool` | `false` | `PTAH_VERBOSE` | — |
| `--verify-sum` | `bool` | `false` | `PTAH_VERIFY_SUM` | — |

</div>

**`ptah migrations tag`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--delete` | `bool` | `false` | `PTAH_DELETE` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--migrations-engine` | `string` | — | `PTAH_MIGRATIONS_ENGINE` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah migrations test`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | — | — |
| `--dir` | `string` | `./tests` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `ptah` | `PTAH_DIR_FORMAT` | — |
| `--migrations-dir` | `string` | `./migrations` | `PTAH_MIGRATIONS_DIR` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--report` | `string` | `text` | `PTAH_REPORT` | — |
| `--root-dir` | `string` | `./models` | `PTAH_ROOT_DIR` | — |
| `--run` | `string` | — | `PTAH_RUN` | — |
| `--seed-dir` | `string` | — | `PTAH_SEED_DIR` | — |

</div>

**`ptah migrations up`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--actor` | `string` | — | `PTAH_ACTOR` | — |
| `--allow-destructive` | `bool` | `false` | `PTAH_ALLOW_DESTRUCTIVE` | — |
| `--allow-dirty` | `bool` | `false` | `PTAH_ALLOW_DIRTY` | — |
| `--atlas-env` | `string` | — | `PTAH_ATLAS_ENV` | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--exec-order` | `string` | `linear` | `PTAH_EXEC_ORDER` | — |
| `--json` | `bool` | `false` | `PTAH_JSON` | — |
| `--limit` | `uint64` | `0` | `PTAH_LIMIT` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--log-format` | `string` | `text` | `PTAH_LOG_FORMAT` | — |
| `--log-level` | `string` | `info` | `PTAH_LOG_LEVEL` | — |
| `--metrics-addr` | `string` | — | `PTAH_METRICS_ADDR` | — |
| `--migration-lock-timeout` | `string` | — | `PTAH_MIGRATION_LOCK_TIMEOUT` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--migrations-engine` | `string` | — | `PTAH_MIGRATIONS_ENGINE` | — |
| `--migrations-schema` | `string` | — | `PTAH_MIGRATIONS_SCHEMA` | — |
| `--migrations-table` | `string` | — | `PTAH_MIGRATIONS_TABLE` | — |
| `--mysqldump-to` | `string` | — | `PTAH_MYSQLDUMP_TO` | — |
| `--pg-dump-to` | `string` | — | `PTAH_PG_DUMP_TO` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--pre-up-hook` | `string` | — | `PTAH_PRE_UP_HOOK` | — |
| `--revision-format` | `string` | `ptah` | `PTAH_REVISION_FORMAT` | — |
| `--skip-checks` | `bool` | `false` | `PTAH_SKIP_CHECKS` | — |
| `--skip-report` | `bool` | `false` | `PTAH_SKIP_REPORT` | — |
| `--statement-timeout` | `string` | — | `PTAH_STATEMENT_TIMEOUT` | — |
| `--to-version` | `string` | — | `PTAH_TO_VERSION` | — |
| `--tx-mode` | `string` | `file` | `PTAH_TX_MODE` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |
| `--verbose` | `bool` | `false` | `PTAH_VERBOSE` | — |
| `--verify-sum` | `bool` | `false` | `PTAH_VERIFY_SUM` | — |
| `--webhook` | `string` | — | `PTAH_WEBHOOK` | — |

</div>

**`ptah migrations validate`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dir` | `string` | `./migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `auto` | `PTAH_DIR_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |

</div>

**`ptah oci capabilities`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |

</div>

**`ptah oci copy`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--recursive` | `bool` | `false` | `PTAH_RECURSIVE` | — |
| `--tag` | `stringArray` | `[]` | `PTAH_TAG` | — |

</div>

**`ptah oci fetch`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--digest` | `string` | — | `PTAH_DIGEST` | — |
| `--file` | `string` | — | `PTAH_FILE` | — |
| `--output`, `-o` | `string` | — | `PTAH_OUTPUT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--type` | `string` | `all` | `PTAH_TYPE` | — |

</div>

**`ptah oci inspect`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--no-referrers` | `bool` | `false` | `PTAH_NO_REFERRERS` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |

</div>

**`ptah oci login`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--password-stdin` | `bool` | `false` | `PTAH_PASSWORD_STDIN` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--username`, `-u` | `string` | — | `PTAH_USERNAME` | — |

</div>

**`ptah oci referrers`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--type` | `string` | `all` | `PTAH_TYPE` | — |

</div>

**`ptah oci reindex`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |

</div>

**`ptah oci resolve`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |

</div>

**`ptah oci tag`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |

</div>

**`ptah oci tags`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |

</div>

**`ptah oci verify`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--policy` | `string` | — | `PTAH_POLICY` | — |

</div>

**`ptah project adopt`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--atlas-config` | `string` | — | `PTAH_ATLAS_CONFIG` | — |
| `--check` | `bool` | `false` | `PTAH_CHECK` | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--preflight` | `bool` | `false` | `PTAH_PREFLIGHT` | — |

</div>

**`ptah project inspect`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--atlas-config` | `string` | — | `PTAH_ATLAS_CONFIG` | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |

</div>

**`ptah schema annotations`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--format` | `string` | `json-schema` | `PTAH_FORMAT` | — |
| `--out` | `string` | — | `PTAH_OUT` | — |

</div>

**`ptah schema apply`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allowed-signers` | `string` | — | `PTAH_ALLOWED_SIGNERS` | — |
| `--auto-approve` | `bool` | `false` | — | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--edit` | `bool` | `false` | `PTAH_EDIT` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--plan` | `string` | — | `PTAH_PLAN` | — |
| `--protected-table` | `stringArray` | `[]` | `PTAH_PROTECTED_TABLE` | — |
| `--require-approval` | `bool` | `false` | `PTAH_REQUIRE_APPROVAL` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--signer` | `string` | — | `PTAH_SIGNER` | — |
| `--to` | `stringArray` | `[]` | `PTAH_TO` | — |
| `--tx-mode` | `string` | — | `PTAH_TX_MODE` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah schema approve`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--key` | `string` | — | `PTAH_KEY` | — |
| `--plan` | `string` | — | `PTAH_PLAN` | — |

</div>

**`ptah schema compare`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-external-schema` | `bool` | `false` | `PTAH_ALLOW_EXTERNAL_SCHEMA` | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--exit-code` | `bool` | `false` | `PTAH_EXIT_CODE` | — |
| `--ignore-extension` | `stringArray` | `[]` | `PTAH_IGNORE_EXTENSION` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-cmd` | `string` | — | `PTAH_SCHEMA_CMD` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--schema-format` | `string` | `sql` | `PTAH_SCHEMA_FORMAT` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah schema diff`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--format` | `string` | `sql` | `PTAH_FORMAT` | — |
| `--from` | `stringArray` | `[]` | `PTAH_FROM` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--to` | `stringArray` | `[]` | `PTAH_TO` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah schema drift`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-external-schema` | `bool` | `false` | `PTAH_ALLOW_EXTERNAL_SCHEMA` | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--exit-code` | `bool` | `true` | `PTAH_EXIT_CODE` | — |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--ignore` | `stringArray` | `[]` | `PTAH_IGNORE` | — |
| `--ignore-extension` | `stringArray` | `[]` | `PTAH_IGNORE_EXTENSION` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-cmd` | `string` | — | `PTAH_SCHEMA_CMD` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--schema-format` | `string` | `sql` | `PTAH_SCHEMA_FORMAT` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--severity` | `string` | `all` | `PTAH_SEVERITY` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah schema export`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--api-field-policy` | `string` | `all` | `PTAH_API_FIELD_POLICY` | — |
| `--cleanup-diff` | `bool` | `false` | `PTAH_CLEANUP_DIFF` | — |
| `--cleanup-dry-run` | `bool` | `false` | `PTAH_CLEANUP_DRY_RUN` | — |
| `--cleanup-go-annotations` | `bool` | `false` | `PTAH_CLEANUP_GO_ANNOTATIONS` | — |
| `--exclude-tables` | `stringSlice` | `[]` | `PTAH_EXCLUDE_TABLES` | — |
| `--from` | `string` | `go` | `PTAH_FROM` | — |
| `--go-package` | `string` | — | `PTAH_GO_PACKAGE` | — |
| `--graphql-operations` | `stringSlice` | `[]` | `PTAH_GRAPHQL_OPERATIONS` | — |
| `--include-tables` | `stringSlice` | `[]` | `PTAH_INCLUDE_TABLES` | — |
| `--open` | `bool` | `false` | `PTAH_OPEN` | — |
| `--out` | `string` | — | `PTAH_OUT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--proto-comments` | `string` | `none` | `PTAH_PROTO_COMMENTS` | — |
| `--proto-on-field-removal` | `string` | `error` | `PTAH_PROTO_ON_FIELD_REMOVAL` | — |
| `--proto-on-incompatible-change` | `string` | `error` | `PTAH_PROTO_ON_INCOMPATIBLE_CHANGE` | — |
| `--proto-on-name-reuse` | `string` | `error` | `PTAH_PROTO_ON_NAME_REUSE` | — |
| `--proto-on-type-move` | `string` | `error` | `PTAH_PROTO_ON_TYPE_MOVE` | — |
| `--proto-package` | `string` | — | `PTAH_PROTO_PACKAGE` | — |
| `--proto-split` | `string` | `none` | `PTAH_PROTO_SPLIT` | — |
| `--proto-type-removal` | `string` | `error` | `PTAH_PROTO_TYPE_REMOVAL` | — |
| `--root-dir` | `string` | `.` | `PTAH_ROOT_DIR` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--title` | `string` | — | `PTAH_TITLE` | — |
| `--to` | `string` | `hcl` | `PTAH_TO` | — |

</div>

**`ptah schema fmt`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--check` | `bool` | `false` | `PTAH_CHECK` | — |

</div>

**`ptah schema inspect`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--format` | `string` | `hcl` | `PTAH_FORMAT` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--migrations-dir` | `string` | — | `PTAH_MIGRATIONS_DIR` | — |
| `--out-dir` | `string` | — | `PTAH_OUT_DIR` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--split` | `string` | — | `PTAH_SPLIT` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah schema lineage`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dialect` | `string` | `postgres` | `PTAH_DIALECT` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--format` | `string` | `table` | `PTAH_FORMAT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah schema plan`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--name` | `string` | — | `PTAH_NAME` | — |
| `--output` | `string` | — | `PTAH_OUTPUT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--protected-table` | `stringArray` | `[]` | `PTAH_PROTECTED_TABLE` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--save` | `bool` | `false` | `PTAH_SAVE` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah schema pull`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--out` | `string` | — | `PTAH_OUT` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |

</div>

**`ptah schema push`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--checks` | `string` | — | `PTAH_CHECKS` | — |
| `--dialect` | `string` | — | `PTAH_DIALECT` | — |
| `--generated-version` | `bool` | `false` | `PTAH_GENERATED_VERSION` | — |
| `--latest` | `bool` | `false` | `PTAH_LATEST` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--tag` | `stringArray` | `[]` | `PTAH_TAG` | — |
| `--version` | `string` | — | `PTAH_VERSION` | — |

</div>

**`ptah schema render`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-external-schema` | `bool` | `false` | `PTAH_ALLOW_EXTERNAL_SCHEMA` | — |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--dialect` | `string` | — | `PTAH_DIALECT` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-cmd` | `string` | — | `PTAH_SCHEMA_CMD` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--schema-format` | `string` | `sql` | `PTAH_SCHEMA_FORMAT` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah schema security`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--fail-on` | `string` | `error` | `PTAH_FAIL_ON` | — |
| `--format` | `string` | `table` | `PTAH_FORMAT` | — |
| `--role-usage` | `string` | — | `PTAH_ROLE_USAGE` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |

</div>

**`ptah schema serve`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--addr` | `string` | `127.0.0.1:7070` | `PTAH_ADDR` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--refresh` | `duration` | `30s` | `PTAH_REFRESH` | — |
| `--root-dir` | `stringSlice` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |
| `--title` | `string` | — | `PTAH_TITLE` | — |

</div>

**`ptah schema stats`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |

</div>

**`ptah schema test`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | — | — |
| `--dir` | `string` | `./tests` | `PTAH_DIR` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--report` | `string` | `text` | `PTAH_REPORT` | — |
| `--root-dir` | `string` | `./models` | `PTAH_ROOT_DIR` | — |
| `--run` | `string` | — | `PTAH_RUN` | — |
| `--schema` | `stringArray` | `[]` | `PTAH_SCHEMA` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--seed-dir` | `string` | — | `PTAH_SEED_DIR` | — |
| `--source-db-url` | `string` | — | `PTAH_SOURCE_DB_URL` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah schema validate`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--dialect` | `stringArray` | `[]` | `PTAH_DIALECT` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--no-skipped` | `bool` | `false` | `PTAH_NO_SKIPPED` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

**`ptah schema verify-approval`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allowed-signers` | `string` | — | `PTAH_ALLOWED_SIGNERS` | — |
| `--plan` | `string` | — | `PTAH_PLAN` | — |
| `--signer` | `string` | — | `PTAH_SIGNER` | — |

</div>

**`ptah seed`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-prod` | `bool` | `false` | `PTAH_ALLOW_PROD` | — |
| `--connect-timeout` | `string` | `10s` | `PTAH_CONNECT_TIMEOUT` | — |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--force` | `bool` | `false` | `PTAH_FORCE` | — |
| `--idempotent` | `bool` | `false` | `PTAH_IDEMPOTENT` | — |
| `--protected-env` | `stringArray` | `[prod,production]` | `PTAH_PROTECTED_ENV` | — |
| `--protected-table` | `stringArray` | `[]` | `PTAH_PROTECTED_TABLE` | — |
| `--seeds-dir` | `string` | `seeds` | `PTAH_SEEDS_DIR` | — |
| `--verbose` | `bool` | `false` | `PTAH_VERBOSE` | — |

</div>

**`ptah sql lint`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dialect` | `string` | — | `PTAH_DIALECT` | — |
| `--disable` | `stringArray` | `[]` | `PTAH_DISABLE` | — |
| `--format` | `string` | `text` | `PTAH_FORMAT` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--stdin` | `bool` | `false` | `PTAH_STDIN` | — |

</div>

**`ptah viz`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--config` | `string` | — | `PTAH_CONFIG` | — |
| `--dialect` | `string` | `postgres` | `PTAH_DIALECT` | — |
| `--env` | `string` | — | `PTAH_ENV` | — |
| `--exclude-tables` | `string` | — | `PTAH_EXCLUDE_TABLES` | — |
| `--format` | `string` | `mermaid` | `PTAH_FORMAT` | — |
| `--include-columns` | `bool` | `false` | `PTAH_INCLUDE_COLUMNS` | — |
| `--plain-http` | `bool` | `false` | `PTAH_PLAIN_HTTP` | — |
| `--root-dir` | `stringArray` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-file` | `stringArray` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--security` | `bool` | `false` | `PTAH_SECURITY` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |
| `--theme` | `string` | `light` | `PTAH_THEME` | — |
| `--var` | `stringArray` | `[]` | `PTAH_VAR` | — |

</div>

## `ptah-compat`

**`ptah-compat completion bash`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--no-descriptions` | `bool` | `false` | `PTAH_NO_DESCRIPTIONS` | — |

</div>

**`ptah-compat completion fish`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--no-descriptions` | `bool` | `false` | `PTAH_NO_DESCRIPTIONS` | — |

</div>

**`ptah-compat completion powershell`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--no-descriptions` | `bool` | `false` | `PTAH_NO_DESCRIPTIONS` | — |

</div>

**`ptah-compat completion zsh`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--no-descriptions` | `bool` | `false` | `PTAH_NO_DESCRIPTIONS` | — |

</div>

**`ptah-compat migrate`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--config`, `-c` | `string` | `file://atlas.hcl` | `PTAH_CONFIG` | inherited by subcommands |
| `--env` | `string` | — | `PTAH_ENV` | inherited by subcommands |
| `--var` | `<name>=<value>` | `[]` | `PTAH_VAR` | inherited by subcommands |

</div>

**`ptah-compat migrate apply`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--allow-dirty` | `bool` | `false` | `PTAH_ALLOW_DIRTY` | — |
| `--baseline` | `string` | — | `PTAH_BASELINE` | — |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--exec-order` | `string` | `linear` | `PTAH_EXEC_ORDER` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--lock-name` | `string` | — | `PTAH_LOCK_NAME` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--revisions-schema` | `string` | — | `PTAH_REVISIONS_SCHEMA` | — |
| `--skip-lock` | `bool` | `false` | `PTAH_SKIP_LOCK` | — |
| `--to-version` | `string` | — | `PTAH_TO_VERSION` | — |
| `--tx-mode` | `string` | `file` | `PTAH_TX_MODE` | — |
| `--url`, `-u` | `string` | — | `PTAH_URL` | — |

</div>

**`ptah-compat migrate checkpoint`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dir` | `string` | — | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |
| `--edit` | `bool` | `false` | `PTAH_EDIT` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--qualifier` | `string` | — | `PTAH_QUALIFIER` | — |
| `--schema`, `-s` | `stringSlice` | `[]` | `PTAH_SCHEMA` | — |

</div>

**`ptah-compat migrate diff`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | hidden |
| `--edit` | `bool` | `false` | `PTAH_EDIT` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--qualifier` | `string` | — | `PTAH_QUALIFIER` | — |
| `--schema`, `-s` | `stringArray` | `[]` | `PTAH_SCHEMA` | — |
| `--to` | `stringArray` | `[]` | `PTAH_TO` | — |

</div>

**`ptah-compat migrate down`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dir` | `string` | — | `PTAH_DIR` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--plan` | `bool` | `false` | `PTAH_PLAN` | — |
| `--revisions-schema` | `string` | — | `PTAH_REVISIONS_SCHEMA` | — |
| `--skip-checks` | `bool` | `false` | `PTAH_SKIP_CHECKS` | — |
| `--to-tag` | `string` | — | `PTAH_TO_TAG` | — |
| `--to-version` | `string` | — | `PTAH_TO_VERSION` | — |
| `--url`, `-u` | `string` | — | `PTAH_URL` | — |

</div>

**`ptah-compat migrate edit`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |

</div>

**`ptah-compat migrate hash`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |

</div>

**`ptah-compat migrate import`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |
| `--from` | `string` | `file://migrations` | `PTAH_FROM` | — |
| `--to` | `string` | `file://migrations` | `PTAH_TO` | — |

</div>

**`ptah-compat migrate lint`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--git-base` | `string` | — | `PTAH_GIT_BASE` | — |
| `--git-dir` | `string` | `.` | `PTAH_GIT_DIR` | — |
| `--latest` | `uint` | `0` | `PTAH_LATEST` | — |

</div>

**`ptah-compat migrate ls`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--latest`, `-l` | `bool` | `false` | `PTAH_LATEST` | — |
| `--short`, `-s` | `bool` | `false` | `PTAH_SHORT` | — |

</div>

**`ptah-compat migrate new`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |
| `--edit` | `bool` | `false` | `PTAH_EDIT` | — |

</div>

**`ptah-compat migrate rebase`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |

</div>

**`ptah-compat migrate rm`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |

</div>

**`ptah-compat migrate set`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |
| `--revisions-schema` | `string` | — | `PTAH_REVISIONS_SCHEMA` | — |
| `--url`, `-u` | `string` | — | `PTAH_URL` | — |

</div>

**`ptah-compat migrate show`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |

</div>

**`ptah-compat migrate status`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--revisions-schema` | `string` | — | `PTAH_REVISIONS_SCHEMA` | — |
| `--url`, `-u` | `string` | — | `PTAH_URL` | — |

</div>

**`ptah-compat migrate test`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |
| `--report` | `string` | — | `PTAH_REPORT` | — |
| `--revisions-schema` | `string` | — | `PTAH_REVISIONS_SCHEMA` | — |
| `--run` | `string` | — | `PTAH_RUN` | — |
| `--seed-dir` | `string` | — | `PTAH_SEED_DIR` | — |

</div>

**`ptah-compat migrate validate`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dir` | `string` | `file://migrations` | `PTAH_DIR` | — |
| `--dir-format` | `string` | `atlas` | `PTAH_DIR_FORMAT` | — |

</div>

**`ptah-compat schema`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--config`, `-c` | `string` | `file://atlas.hcl` | `PTAH_CONFIG` | inherited by subcommands |
| `--env` | `string` | — | `PTAH_ENV` | inherited by subcommands |
| `--var` | `<name>=<value>` | `[]` | `PTAH_VAR` | inherited by subcommands |

</div>

**`ptah-compat schema apply`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--auto-approve` | `bool` | `false` | — | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--edit` | `bool` | `false` | `PTAH_EDIT` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--file`, `-f` | `stringArray` | `[]` | `PTAH_FILE` | hidden |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--lock-name` | `string` | — | `PTAH_LOCK_NAME` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--plan` | `string` | — | `PTAH_PLAN` | — |
| `--schema`, `-s` | `stringArray` | `[]` | `PTAH_SCHEMA` | — |
| `--skip-lint` | `bool` | `false` | `PTAH_SKIP_LINT` | — |
| `--skip-lock` | `bool` | `false` | `PTAH_SKIP_LOCK` | — |
| `--to` | `stringArray` | `[]` | `PTAH_TO` | — |
| `--tx-mode` | `string` | — | `PTAH_TX_MODE` | — |
| `--url`, `-u` | `string` | — | `PTAH_URL` | — |

</div>

**`ptah-compat schema clean`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--auto-approve` | `bool` | `false` | — | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--url`, `-u` | `string` | — | `PTAH_URL` | — |

</div>

**`ptah-compat schema diff`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--export` | `bool` | `false` | `PTAH_EXPORT` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--from`, `-f` | `stringArray` | `[]` | `PTAH_FROM` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--schema`, `-s` | `stringArray` | `[]` | `PTAH_SCHEMA` | — |
| `--to` | `stringArray` | `[]` | `PTAH_TO` | — |
| `--web`, `-w` | `bool` | `false` | `PTAH_WEB` | — |

</div>

**`ptah-compat schema inspect`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--export` | `bool` | `false` | `PTAH_EXPORT` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--output`, `-o` | `string` | — | `PTAH_OUTPUT` | — |
| `--schema`, `-s` | `stringArray` | `[]` | `PTAH_SCHEMA` | — |
| `--url`, `-u` | `string` | — | `PTAH_URL` | — |
| `--web`, `-w` | `bool` | `false` | `PTAH_WEB` | — |

</div>

**`ptah-compat schema plan`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--auto-approve` | `bool` | `false` | `PTAH_AUTO_APPROVE` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--directive`, `-d` | `stringArray` | `[]` | `PTAH_DIRECTIVE` | — |
| `--dry-run` | `bool` | `false` | `PTAH_DRY_RUN` | — |
| `--edit` | `bool` | `false` | `PTAH_EDIT` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--from` | `stringArray` | `[]` | `PTAH_FROM` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--name` | `string` | — | `PTAH_NAME` | — |
| `--name-format` | `string` | — | `PTAH_NAME_FORMAT` | — |
| `--output`, `-o` | `string` | — | `PTAH_OUTPUT` | — |
| `--pending` | `bool` | `false` | `PTAH_PENDING` | — |
| `--push` | `bool` | `false` | `PTAH_PUSH` | — |
| `--repo` | `string` | — | `PTAH_REPO` | — |
| `--save` | `bool` | `false` | `PTAH_SAVE` | — |
| `--schema`, `-s` | `stringArray` | `[]` | `PTAH_SCHEMA` | — |
| `--skip-lint` | `bool` | `false` | `PTAH_SKIP_LINT` | — |
| `--to` | `stringArray` | `[]` | `PTAH_TO` | — |

</div>

**`ptah-compat schema plan lint`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--auto-approve` | `bool` | `false` | `PTAH_AUTO_APPROVE` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--file`, `-f` | `string` | — | `PTAH_FILE` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--from` | `stringArray` | `[]` | `PTAH_FROM` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--repo` | `string` | — | `PTAH_REPO` | — |
| `--schema`, `-s` | `stringArray` | `[]` | `PTAH_SCHEMA` | — |
| `--to` | `stringArray` | `[]` | `PTAH_TO` | — |

</div>

**`ptah-compat schema plan new`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--auto-approve` | `bool` | `false` | `PTAH_AUTO_APPROVE` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--edit` | `bool` | `false` | `PTAH_EDIT` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--from` | `stringArray` | `[]` | `PTAH_FROM` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--name` | `string` | — | `PTAH_NAME` | — |
| `--name-format` | `string` | — | `PTAH_NAME_FORMAT` | — |
| `--output`, `-o` | `string` | — | `PTAH_OUTPUT` | — |
| `--repo` | `string` | — | `PTAH_REPO` | — |
| `--schema`, `-s` | `stringArray` | `[]` | `PTAH_SCHEMA` | — |
| `--to` | `stringArray` | `[]` | `PTAH_TO` | — |

</div>

**`ptah-compat schema plan test`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--run` | `string` | — | `PTAH_RUN` | — |

</div>

**`ptah-compat schema plan validate`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--auto-approve` | `bool` | `false` | `PTAH_AUTO_APPROVE` | — |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--exclude` | `stringArray` | `[]` | `PTAH_EXCLUDE` | — |
| `--file`, `-f` | `string` | — | `PTAH_FILE` | — |
| `--format` | `string` | — | `PTAH_FORMAT` | — |
| `--from` | `stringArray` | `[]` | `PTAH_FROM` | — |
| `--include` | `stringArray` | `[]` | `PTAH_INCLUDE` | — |
| `--lock-timeout` | `string` | — | `PTAH_LOCK_TIMEOUT` | — |
| `--repo` | `string` | — | `PTAH_REPO` | — |
| `--schema`, `-s` | `stringArray` | `[]` | `PTAH_SCHEMA` | — |
| `--to` | `stringArray` | `[]` | `PTAH_TO` | — |

</div>

**`ptah-compat schema stats inspect`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--db-url` | `string` | — | `PTAH_DB_URL` | — |
| `--schemas` | `string` | — | `PTAH_SCHEMAS` | — |

</div>

**`ptah-compat schema test`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dev-url` | `string` | — | `PTAH_DEV_URL` | — |
| `--report` | `string` | — | `PTAH_REPORT` | — |
| `--run` | `string` | — | `PTAH_RUN` | — |
| `--schema`, `-s` | `string` | — | `PTAH_SCHEMA` | — |
| `--seed-dir` | `string` | — | `PTAH_SEED_DIR` | — |
| `--url`, `-u` | `string` | — | `PTAH_URL` | — |

</div>

**`ptah-compat schema validate`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--dialect` | `stringSlice` | `[]` | `PTAH_DIALECT` | — |
| `--root-dir` | `stringSlice` | `[]` | `PTAH_ROOT_DIR` | — |
| `--schema-file` | `stringSlice` | `[]` | `PTAH_SCHEMA_FILE` | — |
| `--server-version` | `string` | — | `PTAH_SERVER_VERSION` | — |

</div>

**`ptah-compat script exec`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--file` | `string` | — | `PTAH_FILE` | — |
| `--quiet` | `bool` | `false` | `PTAH_QUIET` | — |
| `--run` | `string` | — | `PTAH_RUN` | — |
| `--url` | `string` | — | `PTAH_URL` | — |

</div>

**`ptah-compat script loop`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--file` | `string` | — | `PTAH_FILE` | — |
| `--quiet` | `bool` | `false` | `PTAH_QUIET` | — |
| `--run` | `string` | — | `PTAH_RUN` | — |
| `--url` | `string` | — | `PTAH_URL` | — |

</div>

**`ptah-compat script query`**

<div class="ptah-wide-table">

| Flag | Type | Default | Environment variable | Notes |
| --- | --- | --- | --- | --- |
| `--file` | `string` | — | `PTAH_FILE` | — |
| `--quiet` | `bool` | `false` | `PTAH_QUIET` | — |
| `--run` | `string` | — | `PTAH_RUN` | — |
| `--url` | `string` | — | `PTAH_URL` | — |

</div>
