Skip to content

Commit f89323b

Browse files
committed
Document the environment preflight flags in the CLI reference
1 parent c504288 commit f89323b

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

‎plain2code_cli.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
```text
44
usage: generate_cli.py [-h] [--verbose] [--base-folder BASE_FOLDER] [--build-folder BUILD_FOLDER] [--log-to-file | --no-log-to-file] [--log-file-name LOG_FILE_NAME]
55
[--config-name CONFIG_NAME] [--render-range RENDER_RANGE | --render-from RENDER_FROM] [--force-render] [--unittests-script UNITTESTS_SCRIPT]
6-
[--conformance-tests-script CONFORMANCE_TESTS_SCRIPT] [--prepare-environment-script PREPARE_ENVIRONMENT_SCRIPT] [--test-script-timeout TEST_SCRIPT_TIMEOUT]
6+
[--conformance-tests-script CONFORMANCE_TESTS_SCRIPT] [--prepare-environment-script PREPARE_ENVIRONMENT_SCRIPT] [--skip-env-check] [--env-check-only]
7+
[--test-script-timeout TEST_SCRIPT_TIMEOUT]
78
[--api [API]] [--api-key API_KEY] [--full-plain] [--dry-run] [--replay-with REPLAY_WITH] [--template-dir TEMPLATE_DIR] [--copy-build] [--build-dest BUILD_DEST]
89
[--copy-conformance-tests] [--conformance-tests-dest CONFORMANCE_TESTS_DEST] [--render-machine-graph] [--logging-config-path LOGGING_CONFIG_PATH] [--headless]
910
[--status] [--version]
@@ -42,6 +43,9 @@ are used as-is.
4243
containing generated source code, 2) Path to a subfolder of the module's tests folder (e.g. `plain_modules/module_name/tests/subfoldername`) containing test files.
4344
--prepare-environment-script PREPARE_ENVIRONMENT_SCRIPT
4445
Path to a shell script that prepares the testing environment. The script should accept the source code folder path as its first argument.
46+
--skip-env-check Skip the environment preflight that runs before rendering starts. The preflight verifies that the toolchains, environment variables and services
47+
the specs and testing scripts depend on are actually available on this machine.
48+
--env-check-only Run the environment preflight and exit without rendering. Exits with a non-zero status when the environment is not ready.
4549
--test-script-timeout TEST_SCRIPT_TIMEOUT
4650
Timeout for test scripts in seconds. If not provided, the default timeout of 120 seconds is used.
4751
--api [API] Alternative base URL for the API. Default: `https://api.codeplain.ai`

0 commit comments

Comments
 (0)