utopya projects#
utopya projects#
Show available projects and register new ones.
Usage
utopya projects [OPTIONS] COMMAND [ARGS]...
edit#
Edit a project’s registry file directly.
Usage
utopya projects edit [OPTIONS] PROJECT_NAME
Arguments
- PROJECT_NAME#
Required argument
ls#
Lists all registered projects.
Usage
utopya projects ls [OPTIONS]
Options
- -l, --long#
Show more detailed information.
register#
Register a project or validate an existing one.
Required arguments are the base directory of the project.
Usage
utopya projects register [OPTIONS] BASE_DIR
Options
- --info-file <info_file>#
A file that contains all additional project information like the project name, relevant paths, or other metadata. If not given, will search for some candidate files relative to
BASE_DIR, e.g..utopya-project.yml.
- --custom-name <custom_project_name>#
A custom project name that may differ from the one given in the project info file.
- --require-matching-names#
If set, requires that an optionally given
--custom-nameand the name set in the project info file match exactly.
- --exists-action <exists_action>#
What to do if a project of the same name is already registered.
- Options:
raise | validate | overwrite | update
- --with-models#
If set, will additionally register all models in the project’s model directory by recursively looking for their manifest files (ending in
_info.yml).
- --label <custom_label>#
If given, this label will be used instead of the one given in the manifest file(s) for model registration. If no custom label is given and the manifest file does not define one either, the default will be
from_manifest_file.
- --set-default#
Whether to set the registered model(s) as default.
Arguments
- BASE_DIR#
Required argument
rm#
Remove a project.
Usage
utopya projects rm [OPTIONS] PROJECT_NAME
Options
- -y#
If given, will skip the confirmation prompt.
Arguments
- PROJECT_NAME#
Required argument