Skip to content

Commit 613b801

Browse files
committed
docs(cli): clarify environment variable option names
Signed-off-by: Vamsi-klu <nrvamsi13@gmail.com>
1 parent b0ce951 commit 613b801

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

‎docs/reference/cli.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,17 @@ Commands:
5454

5555
## Environment variables
5656

57-
CLI options accept defaults from environment variables. Use `SQLMESH_` followed by the uppercase command and option names, replacing hyphens with underscores. Include every command name for nested commands.
57+
CLI options accept defaults from environment variables. Use `SQLMESH_` followed by the command names and the option's Click parameter name, all uppercase with hyphens replaced by underscores. Include every command name for nested commands. The parameter name usually matches the long option, but some differ, as shown below. Aliases share the same environment variable.
5858

5959
| Environment variable | CLI option |
6060
| --- | --- |
6161
| `SQLMESH_PATHS` | `sqlmesh --paths` |
6262
| `SQLMESH_CONFIG` | `sqlmesh --config` |
6363
| `SQLMESH_PLAN_START` | `sqlmesh plan --start` |
64+
| `SQLMESH_PLAN_SKIP_BACKFILL` | `sqlmesh plan --skip-backfill` or `sqlmesh plan --dry-run` |
65+
| `SQLMESH_AUDIT_MODELS` | `sqlmesh audit --model` |
66+
| `SQLMESH_CREATE_TEST_QUERIES` | `sqlmesh create_test --query` |
67+
| `SQLMESH_CREATE_TEST_VARIABLES` | `sqlmesh create_test --var` |
6468
| `SQLMESH_TABLE_DIFF_LIMIT` | `sqlmesh table_diff --limit` |
6569
| `SQLMESH_STATE_EXPORT_OUTPUT_FILE` | `sqlmesh state export --output-file` |
6670
| `SQLMESH_TEST_LOCAL` | `sqlmesh test --local` |

0 commit comments

Comments
 (0)