After creating your project you will need to deploy the runtime on your machine by running a
checkout command. You can check out more than one runtime to your machine, or the same runtime to different locations on your system.
While the following
state checkout methods achieve the same goal (downloading your project from the Platform to deploy on your local machine), each has unique qualities to suit different user needs.
Many of these methods deal with your
activestate.yaml file. Click here for more information about this file and why it is important.
To check out your project and download a project folder containing your project’s
activestate.yaml file to your current working directory, enter
state checkout <orgname>/<projectname>
state checkout exampleorg/Project1
activestate.yamlfile is entirely owned by the user and acts as a shortcut to your project. The file includes project details such as its location online, language and package information, and security features.
state projectsto see where the local checkout (containing your
activestate.yamlfile) and the cached executable checkout locations for each project checked out from the Platform.
To download the
activestate.yaml file directly, enter
state checkout <orgname>/<projectname> .
state checkout Exampleorg/Project1 C:/Perl .
activestate.yamlfile for automation, as it saves having to go into the newly created project folder to access it.
To checkout a project to another location on your system and not your current working directory, enter
state checkout <orgname>/<projectname> <location>
state checkout Exampleorg/Project1 C:/Perl
activestate.yamlfile at the specified location.
To download all files associated with your project (
.exe, etc.) into a specific location on your system, enter
state checkout <orgname>/<projectname> --runtime-path <location of folder>
state checkout Exampleorg/Project1 --runtime-path C:/Perl
c:/Perl). Or if you need to know the location of specific files or folders related to your project.
You can checkout a specific branch of a larger project using the following command
state checkout --branch <branchname> <org/project> <path>
state checkout --branch Childbranch1 Exampleorg/Project1 C:\Perl
activestate.yamlfile directly, and will not create a project folder containging the file.
To find all projects checked out locally, enter the following command
This will produce a list of all currently checked out projects and their locations on your system.