Command Line Interface¶
project-forge¶
Generate projects from compositions and patterns.
Usage:
project-forge [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--help |
boolean | Show this message and exit. | False |
build¶
Build a project from a composition and render it to a directory.
Usage:
project-forge build [OPTIONS] COMPOSITION
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--use-defaults |
boolean | Do not prompt for input and use the defaults specified in the composition. | False |
--output-dir, -o |
directory | The directory to render the composition to. Defaults to the current working directory. | <function <lambda> at 0x7fb769f08860> |
--data-file, -f |
file | The path to a JSON, YAML, or TOML file whose contents are added to the initial context. Great for answering some or all the answers for a composition. | None |
--data, -d |
text | The key-value pairs added to the initial context. Great for providing answers to composition questions. | None |
--help |
boolean | Show this message and exit. | False |
write-schemas¶
Write the JSON schemas for compositions and patterns to the specified output directory.
The JSON schemas are used by IDEs to provide validation and autocompletion. The output directory must exist and be writable by the user.
Usage:
project-forge write-schemas [OPTIONS] OUTPUT_DIR
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |