Skip to content

Commit d10d66a

Browse files
committed
update docs
1 parent 2ac3dc1 commit d10d66a

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

docs/concepts/audits.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ MODEL (
148148

149149
You can execute audits with the `sqlmesh audit` command as follows:
150150
```bash
151-
$ sqlmesh --path project audit -start 2022-01-01 -end 2022-01-02
151+
$ sqlmesh -p project audit -start 2022-01-01 -end 2022-01-02
152152
Found 1 audit(s).
153153
assert_item_price_is_not_null FAIL.
154154

docs/guides/projects.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ To create a project from the command line, follow these steps:
5858

5959
To edit an existing project, open the project file you wish to edit in your preferred editor.
6060

61-
If using CLI or Notebook, you can open a file in your project for editing by using the `sqlmesh` command with the `--path` varaible, and pointing to your project's path as follows:
61+
If using CLI or Notebook, you can open a file in your project for editing by using the `sqlmesh` command with the `-p` varaible, and pointing to your project's path as follows:
6262
6363
```bash
64-
sqlmesh --path <your-project-path>
64+
sqlmesh -p <your-project-path>
6565
```
6666
6767
For more details, refer to [CLI](../reference/cli.md) and [Notebook](../reference/notebook.md).

docs/reference/cli.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Usage: sqlmesh [OPTIONS] COMMAND [ARGS]...
66
SQLMesh command line tool.
77
88
Options:
9-
--path TEXT Path to the models directory.
9+
--paths TEXT Path(s) to the models directory.
1010
--config TEXT Name of the config object.
1111
--help Show this message and exit.
1212
@@ -68,9 +68,9 @@ Usage: sqlmesh evaluate [OPTIONS] MODEL
6868
Evaluate a model and return a dataframe with a default limit of 1000.
6969
7070
Options:
71-
-s, --start TEXT The start datetime of the interval for which this
71+
-s, --start TEXT The start datetime of the interval for which this
7272
command will be applied.
73-
-e, --end TEXT The end datetime of the interval for which this
73+
-e, --end TEXT The end datetime of the interval for which this
7474
command will be applied.
7575
-l, --latest TEXT The latest time used for non-incremental datasets
7676
(defaults to now).
@@ -85,9 +85,9 @@ Usage: sqlmesh render [OPTIONS] MODEL
8585
Renders a model's query, optionally expanding referenced models.
8686
8787
Options:
88-
-s, --start TEXT The start datetime of the interval for which this
88+
-s, --start TEXT The start datetime of the interval for which this
8989
command will be applied.
90-
-e, --end TEXT The end datetime of the interval for which this
90+
-e, --end TEXT The end datetime of the interval for which this
9191
command will be applied.
9292
-l, --latest TEXT The latest time used for non-incremental datasets
9393
(defaults to now).
@@ -128,9 +128,9 @@ Usage: sqlmesh audit [OPTIONS]
128128
129129
Options:
130130
--model TEXT A model to audit. Multiple models can be audited.
131-
-s, --start TEXT The start datetime of the interval for which this
131+
-s, --start TEXT The start datetime of the interval for which this
132132
command will be applied.
133-
-e, --end TEXT The end datetime of the interval for which this
133+
-e, --end TEXT The end datetime of the interval for which this
134134
command will be applied.
135135
-l, --latest TEXT The latest time used for non-incremental datasets
136136
(defaults to now).
@@ -176,6 +176,6 @@ Options:
176176
Usage: sqlmesh migrate
177177
178178
Migrates SQLMesh to the current running version.
179-
179+
180180
Please contact your SQLMesh administrator before doing this.
181181
```

sqlmesh/cli/main.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ def cli(
5959

6060
if not context.models:
6161
raise click.ClickException(
62-
f"`{paths}` doesn't seem to have any models... cd into the proper directory or specify the path(s) with --paths."
62+
f"`{paths}` doesn't seem to have any models... cd into the proper directory or specify the path(s) with -p."
6363
)
6464

6565
ctx.obj = context

sqlmesh/core/config/loader.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def load_config_from_paths(
4444

4545
if config is None:
4646
raise ConfigError(
47-
"SQLMesh config could not be found. Point the cli to the right path with `sqlmesh --path`. If you haven't set up SQLMesh, run `sqlmesh init`."
47+
"SQLMesh config could not be found. Point the cli to the right path with `sqlmesh -p`. If you haven't set up SQLMesh, run `sqlmesh init`."
4848
)
4949

5050
if load_from_env:

0 commit comments

Comments
 (0)