From 89257297a52713135505c7e2cd8a00311bd2f306 Mon Sep 17 00:00:00 2001
From: Jules Bertrand <33326907+julesbertrand@users.noreply.github.com>
Date: Mon, 26 Feb 2024 18:35:15 +0100
Subject: [PATCH] docs: update cli reference (#150)

---
 README.md             | 5 +++--
 docs/CLI_REFERENCE.md | 3 +++
 docs/configuration.md | 4 ++--
 3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 83369c3..a06b066 100644
--- a/README.md
+++ b/README.md
@@ -351,9 +351,9 @@ To check that your pipelines are valid, you can use the `check` command. It uses
 - check that your pipeline can be compiled
 - check that all configs related to the pipeline are respecting the pipeline definition (using a Pydantic model based on pipeline signature)
 
-To validate one specific pipeline:
+To validate one or multiple pipeline(s):
 ```bash
-vertex-deployer check dummy_pipeline
+vertex-deployer check dummy_pipeline <other pipeline name>
 ```
 
 To validate all pipelines in the `vertex/pipelines` folder:
@@ -491,6 +491,7 @@ create
 │  ├─ settings.py
 │  └─ utils
 │     ├─ config.py
+│     ├─ console.py
 │     ├─ exceptions.py
 │     ├─ logging.py
 │     ├─ models.py
diff --git a/docs/CLI_REFERENCE.md b/docs/CLI_REFERENCE.md
index 4f5eef7..ceb88ec 100644
--- a/docs/CLI_REFERENCE.md
+++ b/docs/CLI_REFERENCE.md
@@ -54,6 +54,8 @@ $ vertex-deployer check [OPTIONS] PIPELINE_NAMES...
 **Options**:
 * `--all, -a / --no-all`: Whether to check all pipelines. [default: no-all]
 * `--config-filepath, -cfp PATH`: Path to the json/py file with parameter values and input artifacts to check. If not specified, all config files in the pipeline dir will be checked.
+* `--warn-defaults, -wd / --no-warn-defaults, -nwd`: Whether to warn when a default value is used and not overwritten in config file. [default: warn-defaults]
+* `raise-for-defaults, -rfd / --no-raise-for-defaults, -nrfd`: Whether to raise an validation error when a default value is used.and not overwritten in config file. [default: no-raise-for-defaults]
 * `--raise-error, -re / --no-raise-error, -nre`: Whether to raise an error if the pipeline is not valid. [default: no-raise-error]
 * `--help`: Show this message and exit.
 
@@ -114,6 +116,7 @@ $ vertex-deployer deploy [OPTIONS] PIPELINE_NAME
 * `--schedule, -s / --no-schedule, -ns`: Whether to create a schedule for the pipeline. [default: no-schedule]
 * `--cron TEXT`: Cron expression for scheduling the pipeline. To pass it to the CLI, use hyphens e.g. `0-10-*-*-*`.
 * `--delete-last-schedule, -dls / --no-delete-last-schedule`: Whether to delete the previous schedule before creating a new one. [default: no-delete-last-schedule]
+* ` --scheduler-timezone TEXT` : IANA Timezone for the scheduler. [default: Europe/Paris]
 * `--tags TEXT`: The tags to use when uploading the pipeline. [default: latest]
 * `--config-filepath, -cfp PATH`: Path to the json/py file with parameter values and input artifacts to use when running the pipeline.
 * `--config-name, -cn TEXT`: Name of the json/py file with parameter values and input artifacts to use when running the pipeline. It must be in the pipeline config dir. e.g. `config_dev.json` for `./vertex/configs/{pipeline-name}/config_dev.json`.
diff --git a/docs/configuration.md b/docs/configuration.md
index 5e4839e..ca4b20f 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -12,12 +12,12 @@ You can override default options for specific CLI commands in the pyproject.toml
 You can also override global deployer options such as logging level, or pipelines / config root path to better fit your repo structure.
 
 ```toml title="pyproject.toml"
-[tool.vertex-deployer]
+[tool.vertex_deployer]
 log-level = "INFO"
 pipelines-root-path = "./vertex/pipelines"
 config-root-path = "./configs"
 
-[tool.vertex-deployer.deploy]
+[tool.vertex_deployer.deploy]
 enable-cache = true
 env-file = "example.env"
 compile = true