Skip to content

cli.md

Latest commit

 

History

History
59 lines (45 loc) · 2.43 KB

cli.md

File metadata and controls

59 lines (45 loc) · 2.43 KB
Raw

CLI Usage

The CLI command is datam8 (or python -m datam8). Install the exact selected backend revision using README. Python >=3.12 is declared by pyproject.toml; installed desktop supplies its own runtime.

Discover commands

For local model mutations, compact JSON output, keyed nested edits and batches, see the agent CLI contract.

datam8 --help
datam8 validate --help
datam8 generate --help
datam8 serve --help

CLI flags are version-specific. --solution accepts a .dm8s path or a directory with exactly one solution. Quote paths with spaces. Keep exercises in disposable copies.

Validate and generate

datam8 validate --solution /path/to/copy/ORAYLISDatabricksSample.dm8s
datam8 generate docs --solution /path/to/copy/ORAYLISDatabricksSample.dm8s

The target is a positional name from the descriptor, not a template folder name. With no explicit target, the solution's default applies. --payload selects a registered payload and can be repeated. --clean-output deletes the selected target directory's contents before generation; keep authored files elsewhere. The current --all flag warns that it is ignored: run targets individually rather than relying on its help description.

Wait for the process exit code. Success is exit zero; invalid invocation is reported by Typer and model/loading/generation failures return a nonzero process result. Machine model commands use the documented exit codes. Inspect the error text and newly written files; a checked-in output file alone is not proof of success. Successful generation does not deploy or execute the generated artifacts.

Serve the editor

datam8 serve --solution /path/to/copy/ORAYLISDatabricksSample.dm8s --host 127.0.0.1 --port 0 --token replace-with-a-random-token

Read the readiness JSON for the actual port. Desktop passes a nonempty token; browser development requires compatible frontend URL/auth configuration. See server and the HTTP contract.

Verification boundaries

Run validation and generation on a disposable solution and inspect newly written output. These local checks do not establish installed-desktop, live-source or deployment acceptance. See test setup for fixtures and release compatibility for supported evidence boundaries.