Skip to content
PtahDocs
v0.8.0
Page type: reference

Command flags

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

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 and Atlas-compatible 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.

ptah assist

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 —

ptah assist context

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 —

ptah assist explain

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 —

ptah assist provider list

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

ptah assist provider test

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

ptah assist sessions delete

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

ptah assist sessions list

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

ptah assist sessions prune

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

ptah assist sessions show

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

ptah completion bash

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

ptah completion fish

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

ptah completion powershell

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

ptah completion zsh

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

ptah db capabilities

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

ptah db drop-all

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 —

ptah db read

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

ptah db verify

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 —

ptah inference abandon

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

ptah inference backfill

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 —

ptah inference catchup

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 —

ptah inference cutover

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 —

ptah inference describe

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 —

ptah inference evaluate

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 —

ptah inference index

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 —

ptah inference pause

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 —

ptah inference plan

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 —

ptah inference prepare

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 —

ptah inference probe

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 —

ptah inference resume

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 —

ptah inference retire

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 —

ptah inference rollback

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 —

ptah inference status

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 —

ptah inference verify

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 —

ptah introspect

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 —

ptah mcp

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 —

ptah migrations baseline

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 —

ptah migrations checkpoint

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 —

ptah migrations create

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 —

ptah migrations data

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 —

ptah migrations down

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 —

ptah migrations edit

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 —

ptah migrations generate

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 —

ptah migrations hash

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

ptah migrations import

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 —

ptah migrations lint

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 —

ptah migrations log

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 —

ptah migrations ls

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 —

ptah migrations plan

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 —

ptah migrations pull

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

ptah migrations push

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 —

ptah migrations rebase

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 —

ptah migrations repair

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 —

ptah migrations rm

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 —

ptah migrations set

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 —

ptah migrations show

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 —

ptah migrations status

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 —

ptah migrations tag

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 —

ptah migrations test

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 —

ptah migrations up

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 —

ptah migrations validate

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 —

ptah oci capabilities

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

ptah oci copy

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

ptah oci fetch

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 —

ptah oci inspect

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 —

ptah oci login

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 —

ptah oci referrers

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

ptah oci reindex

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

ptah oci resolve

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

ptah oci tag

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

ptah oci tags

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

ptah oci verify

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

ptah project adopt

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 —

ptah project inspect

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 —

ptah schema annotations

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

ptah schema apply

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 —

ptah schema approve

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

ptah schema compare

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 —

ptah schema diff

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 —

ptah schema drift

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 —

ptah schema export

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 —

ptah schema fmt

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

ptah schema inspect

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 —

ptah schema lineage

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 —

ptah schema plan

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 —

ptah schema pull

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

ptah schema push

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 —

ptah schema render

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 —

ptah schema security

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 —

ptah schema serve

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 —

ptah schema stats

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

ptah schema test

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 —

ptah schema validate

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 —

ptah schema verify-approval

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

ptah seed

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 —

ptah sql lint

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 —

ptah viz

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 —

ptah-compat completion bash

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

ptah-compat completion fish

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

ptah-compat completion powershell

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

ptah-compat completion zsh

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

ptah-compat migrate

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

ptah-compat migrate apply

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 —

ptah-compat migrate checkpoint

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 —

ptah-compat migrate diff

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 —

ptah-compat migrate down

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 —

ptah-compat migrate edit

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

ptah-compat migrate hash

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

ptah-compat migrate import

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 —

ptah-compat migrate lint

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 —

ptah-compat migrate ls

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

ptah-compat migrate new

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

ptah-compat migrate rebase

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

ptah-compat migrate rm

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

ptah-compat migrate set

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 —

ptah-compat migrate show

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

ptah-compat migrate status

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 —

ptah-compat migrate test

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 —

ptah-compat migrate validate

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 —

ptah-compat schema

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

ptah-compat schema apply

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 —

ptah-compat schema clean

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 —

ptah-compat schema diff

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 —

ptah-compat schema inspect

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 —

ptah-compat schema plan

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 —

ptah-compat schema plan lint

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 —

ptah-compat schema plan new

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 —

ptah-compat schema plan test

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

ptah-compat schema plan validate

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 —

ptah-compat schema stats inspect

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

ptah-compat schema test

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 —

ptah-compat schema validate

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 —

ptah-compat script exec

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

ptah-compat script loop

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

ptah-compat script query

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