Options and Flags

This section provides an overview of all available global options. Options or flags that need additional explanation will also be outlined here.

   --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



Specify additional environment variables in a file. Read more about using environment variables here.

Build & Dev flags

This section contains flags that can be used when building or developing locally using wercker dev or wercker build.

   --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]

Docker local


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.

Attach on error

The --attach-on-error flag can be added to both the wercker build as well as the wercker dev command. If a step fails in your pipeline it will re-initiate the container and drop you into a shell inside of the container. This flag is great for debugging and inspect the environment.

You can use it as follows:

wercker dev --publish 5000 --attach-on-error


Used together with wercker dev. Exposes a port from the container to the host.

wercker dev --publish 1337

No remove


When developing locally, you can opt not to remove the development containers locally.

Store S3


You can store your container images and artefacts on Amazon S3 while building or developing. You’ll also need to specify:


When storing artefacts on S3, this key needs to be set.


When storing artefacts on S3, this key needs to be set.


When storing artefacts on S3, specify which bucket it needs to be saved to.


When storing artefacts on S3, specify which region wercker should use.