travis-run.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.46.2.
.TH TRAVIS-RUN "1" "December 2014" "travis-run 0.1" "User Commands"
.SH NAME
travis-run \- Run travis-ci builds locally using Docker
.SH SYNOPSIS
.B travis-run
[\fI\,OPTIONS\/\fR..] [\fI\,BACKEND_OPTIONS\/\fR..] [\fI\,COMMAND \/\fR[\fI\,ARGS\/\fR..]]
.SH "GLOBAL OPTIONS"
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
display this help and exit
.HP
\fB\-\-version\fR
.IP
Display version information and exit
.HP
\fB\-b\fR, \fB\-\-backend\fR=\fI\,BACKEND\/\fR
.IP
Virtualization backend to use. Currently available backends
(defaults to: docker):
.IP
\- docker
.HP
\fB\-k\fR, \fB\-\-keep\fR
.IP
Don't stop and destroy VM after build finishes. This is useful
during development as you will only have to go through
VM creation once. Make sure to `travis\-run clean' or
`travis\-run stop' after you're done with the VM.
.HP
\fB\-n\fR, \fB\-\-vm\-name\fR=\fI\,VM_NAME\/\fR
.IP
Backend specific identifier associated with the VM.
.IP
For the docker backend this should be in the form
`REPOSITORY/IMAGE'. This will be used to pull prebuilt
container images too as to tag built container images when
prebuilts are not found. (defaults to `dxld/travis\-run')
.SH COMMANDS
.SS "run [BUILD_ID | BUILD_CONFIG]:"
.IP
(default if no command given)
Run the build matrix in sequence and abort on the first failure or run
the given BUILD_ID (see the `matrix' command). On failure you will be
dropped into a shell inside the build environment so you can figure
out what's going on.
.TP
\fB\-\-shell\fR
Prepare for a build but instead of running it launch a
shell.
.SS "stop:"
.IP
Stop running build VM. This will tear down the VM as well as all it's
disk state.
.SS "create:"
.IP
Setup build VM. Depending on the backend it might be stored globally
or in `.travis\-run' in the current directory.
.TP
\fB\-\-docker\-base\-image\fR=\fI\,BASE_IMAGE\/\fR
Docker image to use as the base for the container, see
`FROM' Dockerfile command.  (defaults to:
ubuntu:presice)
.TP
\fB\-\-docker\-build\-stage\fR=\fI\,STAGE\/\fR
Stage of the image build to run, (one of: os, base,
script, language, project)
.TP
\fB\-\-docker\-no\-pull\fR
Build all docker containers from scratch, don't try to
pull them from the docker hub.
.SS "clean:"
.IP
Stop running build VM, and clean any backend specific state kept in
the project directory.
.SS "matrix:"
.IP
Print the build matrix. The number in the first column is the
BUILD_ID. The part after the ':' is the BUILD_CONFIG, note that this
is whitespace sensitive.