Permalink
Switch branches/tags
Find file
Fetching contributors…
Cannot retrieve contributors at this time
130 lines (128 sloc) 2.45 KB
.\" Generated with Ronnjs 0.3.8
.\" http://github.com/kapouer/ronnjs/
.
.TH "STAGE\-RUN" "1" "March 2013" "" ""
.
.SH "NAME"
\fBstage-run\fR \-\- Run test
.
.SH "SYNOPSIS"
.
.nf
stage\-run [options] <test>
.
.fi
.
.SH "DESCRIPTION"
Orders Master Server to run specified \fI<test>\fR
.
.SH "OPTIONS"
Available options for command:
.
.IP "\(bu" 4
\fB\-v\fR, \fB\-\-version\fR:
.
.br
Shows current version of the command, then exit
.
.IP "\(bu" 4
\fB\-\-help\fR:
.
.br
Shows the manual page entry for command
.
.IP "\(bu" 4
\fB\-\-usage\fR:
.
.br
Show command usage, then exit
.
.IP "\(bu" 4
\fB\-\-url <url>\fR:
.
.br
Full \fIurl\fR where to the Stage Master Server\. This can also be controlled by setting the STAGE_URL environment variable\.
.
.IP "\(bu" 4
\fB\-\-host <host>\fR:
.
.br
Set the \fIhost\fR of current \fIurl\fR to the Stage Master Server\.
.
.IP "\(bu" 4
\fB\-\-port <port>\fR:
.
.br
Set the \fIport\fR of current \fIurl\fR to the Stage Master Server\.
.
.IP "\(bu" 4
\fB\-\-secure\fR:
.
.br
Indicates that the \fIurl\fR to the Stage Master Server is secure\. The protocol of the \fIurl\fR is changed to \fIhttps\fR
.
.IP "\(bu" 4
\fB\-\-token <token>\fR:
.
.br
Sends the required \fItoken\fR requested by the Stage Master Server\.
.
.IP "\(bu" 4
\fB\-\-json\fR:
.
.br
Format output as JSON instead of text
.
.IP "\(bu" 4
\fB\-\-clients <number>\fR:
.
.br
Number of clients that Master Server should allocate for test\. Default is \'0\' which indicates any number of free clients\.
.
.IP "" 0
.
.P
Each option passed after a double dash (\fI\-\-\fR) is sent to the test as a config parameter\. Config parameters can be accessed through the environmental variable collection in scripts\. The config paramters are prefixed with \fBnpm_package_config_\fR in order to be compatible with \fBnpm\fR\|\.
.
.SH "EXAMPLES"
Runs test \'mytest\' with version \'1\.0\.0\':
.
.IP "" 4
.
.nf
stage\-run mytest@1\.0\.0
.
.fi
.
.IP "" 0
.
.P
Runs test \'mytest\' with config parameter port set to 8080\. The config paramter is accessed in script with \fBprocess\.env["npm_package_config_port"]\fR:
.
.IP "" 4
.
.nf
stage\-run mytest@1\.0\.0 \-\- \-\-port 8080
.
.fi
.
.IP "" 0
.
.SH "ENVIRONMENT VARIABLES"
The following enivornment variables are used by command:
.
.P
\fISTAGE_URL\fR
.
.br
The full URL to the Stage Master Server e\.g \fBhttp://myserver:8080/\fR\|\.
.
.SH "COPYRIGHT"
Copyright (C) 2013 Johan Dahlberg \fIhttp://jfd\.github\.com\fR
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
stage\-run(1)
.
.IP "" 0