Wercker CLI glossary of flags and Options.
In conversation with one of the great teams that use Wercker I uncovered that as much as they love using our open source CLI to develop their pipelines locally, they would find it helpful to have a glossary of flags and options available to them.
And so, we deliver! Here is a glossary of commonly used flags.
For a complete list, please visit our Devcenter.
Options and Flags
This section provides an overview of all available global options.
GLOBAL OPTIONS: --environment "ENVIRONMENT" specify additional environment variables in a file --verbose print more information --no-colors wercker output will not use colors (does not apply to step output) --debug print additional debug information --journal Send logs to systemd-journald. Suppresses stdout logging. --auth-token authentication token to use --help, -h show help --version, -v print the version
You can specify additional environment variables in a file. You can read more about using environment variables here.
Build & Dev flags
OPTIONS: --working-dir "./.wercker" Path where we store working files. [$WERCKER_WORKING_DIR] --deploy-target The deploy target name. [$WERCKER_DEPLOYTARGET_NAME] --docker-host Docker api endpoint. [$DOCKER_HOST] --docker-tls-verify "0" Docker api tls verify. [$DOCKER_TLS_VERIFY] --docker-cert-path Docker api cert path. [$DOCKER_CERT_PATH] --docker-local Don't interact with remote repositories --checkpoint Skip to the next step after a recent build checkpoint. --direct-mount Mount our binds read-write to the pipeline path. --publish [--publish option --publish option] Publish a port from the main container, same format as docker --publish. --enable-volumes Mount local files and directories as volumes to your wercker container, specified in your wercker.yml. --commit Commit the build result locally. --tag Tag for this build. [$WERCKER_GIT_BRANCH] --message Message for this build. --artifacts Store artifacts. --no-remove Don't remove the containers. --store-s3 Store artifacts and containers on s3. --aws-secret-key Secret access key. Used for artifact storage. --aws-access-key Access key id. Used for artifact storage. --s3-bucket "wercker-development" Bucket for artifact storage. --aws-region "us-east-1" AWS region to use for artifact storage. --source-dir Source path relative to checkout root. --no-response-timeout "5" Timeout if no script output is received in this many minutes. --command-timeout "25" Timeout if command does not complete in this many minutes. --wercker-yml Specify a specific yaml file. [$WERCKER_YML_FILE]
This flag can be used with either wercker dev or wercker build. When using this flag, Wercker will not attempt to connect to a remote repository when pulling or pushing images, but will instead look for container images locally, or when using theinternal/docker-push, it will push images to the local repository.
We’re hiring! Check out the careers page for open positions in Amsterdam, London and San Francisco.
As usual, if you want to stay in the loop follow us on twitter @wercker or hop on our public slack channel. If it’s your first time using Wercker, be sure to tweet out your #greenbuilds, and we’ll send you some swag!