Package: colony-cli
Colony CLICloudshell Colony CLIColony CLI is a Command Line interface tool for CloudShell Colony.The main functionality this tool currently provides is validation of Colony Blueprints and launching of Sandbox environments from any branch in addition to testing local changes before committing them.Why use Colony CLIWhen developing Blueprints for Colony, it can be very helpful to immediately check your work for errors.Let's assume you are currently working indevelopmentbranch, and you also have a main branch which is connected
to a Colony space. You would like to be sure that your latest local changes haven't broken anything before commiting to current branch and pushing to remote or before merging changes to main branch.This is where this tool might be handy for you. Instead of reconnecting Colony to your development branch in the UI or going with "merge and pray" you can
use Colony CLI to validate your current Blueprints state and even launch Sandboxes.InstallingYou can install Colony CLI withpip:$ python -m pip install colony-cliOr if you want to install it for your user:$ python -m pip install --user colony-cliConfigurationIn order to allow the CLI tool to authenticate with Colony you must provide several parameters:TokenThe easiest way to generate a token is via the Colony UI. Navigate toSettings (in your space) -> Integrations ->
click “Connect” under any of the CI tools -> click “New Token”to get an API token.SpaceThe space in the Colony to use which is mapped to the Git repo you are usingAccount(optional) providing the account name (appearing as the subdomain in your Colony URL,
e.ghttps://YOURACCOUNT.cloudshellcolony.com). This is not a mandatory value but will help generate easy links.TheToken,SpaceandAccountparameters can be provided via special command line flags (--token,--space,and--accountrespectively) but can be conveniently placed in a config file relative to your user folder,
so they don't need to be provided each time.The config file can be easily created and managed using the interactivecolony configurecommand.
The CLI supports multiple profiles and we recommend setting up a default profile for ease of use. To use a non-default profile the--profilecommand line flag needs to be used to specify the profile name.To add a new profile or update an existing one runcolony configure setand follow the on-screen directions. First you will be able to choose the profile name. Hit enter to add/update the default profile or enter a custom profile name. If the profile exists it will be update and if it doesn't exist then a new profile will be configured.To see all profiles runcolony configure listand the command will output a table of all the profiles that are currently configured. Example output:ProfileNameColonyAccountSpaceNameToken
--------------------------------------------------------------
defaultcolony-demopromotions-manager*********jhtU
custom-profilemy-colonymy-space*********igEwIf a profile is no longer needed it can be easily removed by runningcolony configure remove [profile-name]Thecolony configurecommand will save the config file relative to your home user directory ('~/.colony/config' on Mac and Linux or in '%UserProfile%\.colony\config' on Windows).
If you wish to place the config file in a different location, you can specify that location via an environment variable:$ export COLONY_CONFIG_PATH=/path/to/fileThe different parameters may also be provided as environment variables instead of using the config file:exportCOLONY_TOKEN=xxxzzzyyyexportCOLONY_SPACE=demo_space# OptionalexportCOLONY_ACCOUNT=MYACCOUNTBasic UsageColony CLI currently allows you to make two actions:Validate a Blueprint (using thecolony bp validatecommand)Start a Sandbox (viacolony sb start)In order to get help run:$ colony --helpIt will give you detailed output with usage:$colony--help
Usage:colony[--space=<space>][--token=<token>][--account=<account>][--profile=<profile>][--help][--debug]<command>[<args>...]Options:-h--helpShowthisscreen.--versionShowcurrentversion--space=<space>UseaspecificColonySpace,thiswilloverrideanydefaultsetintheconfigfile--token=<token>Useaspecifictokenforauthentication,thiswilloverrideanydefaultsetintheconfigfile--account=<account>[Optional]YourColonyaccountname.TheaccountnameisequaltoyoursubdomainintheColonyURL.e.g.<https://YOURACCOUNT.cloudshellcolony.com//>--profile=<profile>UseaspecificProfilesectionintheconfigfileYoustillcanoverrideconfigwith--token/--spaceoptions.

Commands:bp,blueprintvalidatecolonyBlueprintssb,sandboxstartaSandbox,endaSandbox,getaSandboxstatusorlistallSandboxesYou can get additional help information for a particular command by specifying--helpflag after command name, like:usage:
        colony (sb | sandbox) start <blueprint_name> [options]
        colony (sb | sandbox) status <sandbox_id>
        colony (sb | sandbox) end <sandbox_id>
        colony (sb | sandbox) list [--filter={all|my|auto}] [--show-ended] [--count=<N>]
        colony (sb | sandbox) [--help]

    options:
       -h --help                        Show this message
       -d, --duration <minutes>         The Sandbox will automatically de-provision at the end of the provided duration
       -n, --name <sandbox_name>        Provide a name for the Sandbox. If not set, the name will be generated
                                        automatically using the source branch (or local changes) and current time.

       -i, --inputs <input_params>      The Blueprints inputs can be provided as a comma-separated list of key=value
                                        pairs. For example: key1=value1,key2=value2.
                                        By default Colony CLI will try to take the default values for these inputs
                                        from the Blueprint definition yaml file.

       -a, --artifacts <artifacts>      A comma-separated list of artifacts per application. These are relative to the
                                        artifact repository root defined in Colony.
                                        Example: appName1=path1, appName2=path2.
                                        By default Colony CLI will try to take artifacts from Blueprint definition yaml
                                        file.

       -b, --branch <branch>            Run the Blueprint version from a remote Git branch. If not provided,
                                        the CLI will attempt to automatically detect the current working branch.
                                        The CLI will automatically run any local uncommitted or untracked changes in a
                                        temporary branch created for the validation or for the development Sandbox.

       -c, --commit <commitId>          Specify a specific Commit ID. This is used in order to run a Sandbox from a
                                        specific Blueprint historic version. If this parameter is used, the
                                        Branch parameter must also be specified.

       -t, --timeout <minutes>          Set how long (default timeout is 30 minutes) to block and wait before releasing
                                        control back to shell prompt. If timeout is reached before the desired status
                                        the wait loop will be interrupted.
                                        If "wait_active" flag is not set and a temp branch is created for local changes,
                                        the CLI will block and wait until the sandbox Infrastructure and Artifacts are
                                        ready. Then the temp branch can be safely deleted and the wait loop will end.
                                        If "wait_active" flag is set, the CLI will block and wait until the sandbox is
                                        Active regardless if temp branch is created or not.

       -w, --wait_active                Block shell prompt and wait for the sandbox to be Active (or deployment ended
                                        with an error) while the timeout is not reached. Default timeout is 30 minutes.
                                        The default timeout can be changed using the "timeout" flag.Blueprint validationIf you are currently inside a git-enabled folder containing your Blueprint, commit and push your latest changes and run (Colony CLI will automatically detect the current working branch):$ colony bp validate MyBlueprintIf you want to validate a Blueprint from another branch you can specify--branchargument or even check validation in a
specific point in time by setting--commit:$ colony bp validate MyBlueprint --branch dev --commit fb88a5e3275q5d54697cff82a160a29885dfed24Testing Local ChangesThe Colony CLI can validate your Blueprints and test your Sandboxes even before you commit and push your code to a
remote branch. It does so by creating a temporary branch on the remote repository with your local staged and even
untracked changes which gets deleted automatically after the Sandbox is created or the Blueprint validation is
complete. The CLI will automatically detect if you have some local changes and use them unless you explicitly
set the --branch flag.Please notice that in order to create a Sandbox from your local changes, the CLI must make sure they are
picked up by the Sandbox setup process before completing the action and deleting the temporary branch. This means
that when you launch a local Sandbox the CLI command will not return immediately. You'll also receive a warning
not to abort the wait as that might not give Colony enough time to pull your changes and the Sandbox may fail.
Feel free to launch the CLI command asynchronously or continue working in a new tab.NOTEIf you are not it git-enabled folder of your Blueprint repo and haven't set --branch/--commit arguments tool will
validate Blueprint with name "MyBlueprint" from branch currently attached to your Colony space.The result will indicate whether the Blueprint is valid. If there are ny issues, you will see them printed out as
a table describing each issue found.Example:$colonyblueprintvalidateJenkins-bmaster

ERROR-colony.commands-Validationfailed
messagename
----------------------------------------------------------------------------------------------------------
Cloudaccount:AWSisnotrecognizedasavalidcloudaccountinthisspaceBlueprintunknowncloudaccountLaunching a SandboxSimilar to the previous command you can omit--branch/--commitarguments if you are in a git-enabled folder of your
Blueprint repo:$ colony sb start MyBlueprintThis will create a Sandbox from the specified BlueprintIf you want to start a Sandbox from a Blueprint in a specific state, specify--branchand--commitarguments:$ colony sb start MyBlueprint --branch dev --commit fb88a5e3275q5d54697cff82a160a29885dfed24Additional optional options that you can provide here are:-d, --duration <minutes>- you can specify duration for the Sandbox environment in minutes. Default is 120 minutes-n, --name <sandbox_name>- the name of the Sandbox you want to create. By default the cli will generate a name using the Blueprint name, branch or local changes, and the current timestamp-i, --inputs <input_params>- comma-separated list of input parameters for the Sandbox, For example:"param1=val1, param2=val2"-a, --artifacts <artifacts>- comma-separated list of Sandbox artifacts, like: "app1=path1, app2=path2"-w, --wait <timeout>-  is a number of minutes. If set, you Colony CLI will wait for the Sandbox to become active and lock your terminal.NOTEIf you are not it git-enabled folder of your Blueprint repo and haven't set --branch/--commit arguments tool will
start a Sandbox using the Blueprint "MyBlueprint" from the branch currently attached to your Colony space.If you omit artifacts and inputs options, you are inside a git enabled folder and the local is in sync with remote,
then Colony Cli will try to get default values for artifacts and inputs from the Blueprint YAML file.Result of the command is a Sandbox ID.Example:colonysbstartMyBlueprint--inputs"CS_COLONY_TOKEN=ABCD, IAM_ROLE=s3access-profile, BUCKET_NAME=abc"ybufpamyok03c11Other functionalityYou can also end a Colony Sandbox by using the "end" command and specifying its Id:$ colony sb end <sandbox> idTo get the current status of a Sandbox status run:$ colony sb status <sandbox> idIn order to list all Sandboxes in your space use the following command:$ colony sb listBy default this command will show only Sandboxes launched by the CLI user which are not in an ended status.You can include historic completed Sandboxes by setting--show-endedflagDefault output length is 25. You can override with option--count=Nwhere N < 1000You can also list Sandboxes created by other users or filter only automation Sandboxes by setting option--filter={all|my|auto}. Default ismy.Troubleshooting and HelpTo troubleshoot what Colony CLI is doing you can add--debugto get additional information.For questions, bug reports or feature requests, please refer to theIssue Tracker.ContributingAll your contributions are welcomed and encouraged. We've compiled detailed information about:ContributingLicenseApache License 2.0