RCC user manual
Here we look in detail at each command that RCC provides.
- For installation instructions see RCC installation instructions.
- For an example workflow and more information check out RCC workflow.
rcc with no arguments to see all commands:
$ rcc rcc rcc is environment manager for Robocorp Automation Stack | | assistant Group of commands related to `robot assistant`. | | list Robot Assistant listing | | run Robot Assistant run | | cloud Group of commands related to `Robocorp Cloud`. | | authorize Convert an API key to a valid authorization JWT token. | | download Fetch an existing robot from Robocorp Cloud. | | new Create a new robot into Robocorp Cloud. | | pull Pull a robot from Robocorp Cloud and unwrap it into local directory. | | push Wrap the local directory and push it into Robocorp Cloud as a specific robot. | | upload Push an existing robot to Robocorp Cloud. | | userinfo Query user information from Robocorp Cloud. | | workspace List the available workspaces and their tasks (with --workspace option). | | community Group of commands related to `Robocorp Community`. | | pull Pull a robot from URL or community sources. | | configure Group of commands related to `rcc configuration`. | | credentials Manage Robocorp Cloud API credentials. | | diagnostics Run system diagnostics to help resolve rcc issues. | | identity Manage rcc instance identity related things. | | longpaths Check and enable Windows longpath support | | env Group of commands related to `environment management`. | | cleanup Cleanup old managed virtual environments. | | delete Delete one managed virtual environment. | | hash Calculates a hash for managed virtual environment from conda.yaml files. | | list Listing currently managed virtual environments. | | new Creates a new managed virtual environment. | | unlease Drop existing lease of given environment. | | variables Export environment specific variables as a JSON structure. | | interactive Group of interactive commands. For human users. Do not use in automation. | | create Create a directory structure for a robot interactively. | | man Group of commands related to `rcc documentation`. | | changelog Show the rcc changelog. | | license Show the rcc License. | | tutorial Show the rcc tutorial. | | robot Group of commands related to `robot`. | | fix Automatically fix known issues inside robots. | | initialize Create a directory structure for a robot. | | libs Manage library dependencies in an action oriented way. | | list List or update tracked robot directories. | | unwrap Unpack a robot back into a directory structure. | | wrap Build a robot out of directory content. | | task Group of commands related to `task`. | | run Run task in place, to debug current setup. | | shell Run the given command inside the given environment | | testrun Run a task in a clean environment and clean directory. Toplevel commands | create Create a directory structure for a robot interactively. | help Help about any command | pull Pull a robot from URL or community sources. | run Run task in place, to debug current setup. | tutorial Show the rcc tutorial. | version Show rcc version number.
You can get more information about the usage of each command by using the
--help optional argument. For example:
rcc robot initialize --help