CLI Reference

realm

Usage:

realm [OPTIONS] COMMAND [ARGS]...

Global Options:

Name	Type	Description	Default
--version, -V	boolean	Display realm version	False
--verbose, -v	integer range (0 and above)	Sets the verbosity level	0
--parallelism, -p	integer	Sets the parallelism for the command (if supported)	1
--since	text	Includes only projects affected by a change since the specified reference	None
--all	boolean	Includes all projects if no projects were changed when using the --since filter	False
--scope	text	Includes only projects that match the given wildcard pattern	None
--ignore	text	Filters out projects that match the given wildcard pattern	None
--match	text	Filters by a field specified in pyproject.toml	None
--help	boolean	Show this message and exit.	False

build

Runs poetry build on all projects, it will replace path-dependencies with their current version in the workspace

Usage:

realm build [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

init

Initializes a new realm repo

Usage:

realm init [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

install

Executes "poetry install" on all projects

Usage:

realm install [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

ls

Prints all projects managed

Usage:

realm ls [OPTIONS]

Options:

Name	Type	Description	Default
--paths	boolean	Prints relative paths of the projects	False
--help	boolean	Show this message and exit.	False

run

Executes a command on all projects

Usage:

realm run [OPTIONS] [COMMAND]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

task

Runs a poe task on all projects containing this task

Usage:

realm task [OPTIONS] TASK_NAME

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False