skrawcz commented on code in PR #1402: URL: https://github.com/apache/hamilton/pull/1402#discussion_r2404953749
########## docs/how-tos/cli-reference.md: ########## @@ -66,11 +73,78 @@ $ hamilton diff [OPTIONS] MODULES... **Options**: +* `--name TEXT`: Name of the dataflow. Default: Derived from MODULES. +* `--context FILE`: Path to Driver context file [.json, .py, .toml]. For TOML files, Hamilton looks for either: + - Top-level Hamilton headers: `HAMILTON_CONFIG`, `HAMILTON_FINAL_VARS`, `HAMILTON_INPUTS`, `HAMILTON_OVERRIDES` + - Tool-specific section: `[tool.hamilton]` with `config`, `final_vars`, `inputs`, `overrides` sub-keys +* `--output-file-path PATH`: Output path of visualization. If path is a directory, use NAME for file name. [default: .] * `--git-reference TEXT`: [default: HEAD] * `--view / --no-view`: [default: no-view] -* `--output-file-path PATH`: [default: diff.png] * `--help`: Show this message and exit. +## `hamilton validate` + +Validate DATAFLOW execution for the given CONTEXT + +**Usage**: + +```console +$ hamilton validate [OPTIONS] MODULES... +``` + +**Arguments**: + +* `MODULES...`: [required] + +**Options**: + +* `--context FILE`: [required] Path to Driver context file [.json, .py, .toml]. For TOML files, Hamilton looks for either: + - Top-level Hamilton headers: `HAMILTON_CONFIG`, `HAMILTON_FINAL_VARS`, `HAMILTON_INPUTS`, `HAMILTON_OVERRIDES` + - Tool-specific section: `[tool.hamilton]` with `config`, `final_vars`, `inputs`, `overrides` sub-keys +* `--name TEXT`: Name of the dataflow. Default: Derived from MODULES. +* `--help`: Show this message and exit. + +## Using TOML Files for Configuration + +Starting with version 2.0.0, the Hamilton CLI supports loading configuration from TOML files, including `pyproject.toml`. You can use either of these two formats: Review Comment: this will be released sooner than 2.0.0. Please update to `1.90.0` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
