.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "COVERALLS" "1" "March 2014" "" ""
.
.SH "NAME"
\fBcoveralls\fR \- Coveralls API client utility
.
.SH "SYNOPSIS"
\fBcoveralls\fR \fIsub\-command\fR
.
.SH "DESCRIPTION"
Coveralls is a command\-line utility to interact with Coveralls web service to help you track your code coverage over time, and ensure that all your new code is fully covered\.
.
.P
Coveralls automatically collects your code coverage data, uploads it to their servers and gives you a nice interface to dig into it\.
.
.P
Any type of Ruby project or test framework supported by SimpleCov is supported by the Coveralls gem\. This includes all your favorites, like RSpec, Cucumber, and Test::Unit\.
.
.SH "SUB\-COMMANDS"
.
.TP
\fBhelp\fR COMMAND
Describe available commands or one specific command\.
.
.TP
\fBlast\fR
View the last build for this repository on Coveralls\.
.
.TP
\fBopen\fR
View this repository on Coveralls\.
.
.TP
\fBpush\fR
Runs your test suite and pushes the coverage results to Coveralls\.
.
.TP
\fBreport\fR
Runs your test suite locally and displays coverage statistics\.
.
.TP
\fBservice\fR
View this repository on your CI service\'s website\.
.
.TP
\fBversion\fR
See version\.
.
.SH "CONFIGURATION"
Coveralls for Ruby uses an optional \fB\.coveralls\.yml\fR file at the root level of your repository to configure options\.
.
.P
The option \fBrepo_token\fR (found on your repository\'s page on Coveralls) is used to specify which project on Coveralls your project maps to\. This is only needed for repos not using a CI and should be kept secret \-\- anyone could use it to submit coverage data on your repo\'s behalf\. This shouldn\'t be a concern for private repos, however\.
.
.P
Another important option is \fBservice_name\fR which allows you to specify where Coveralls should look to find additional information about your builds\. This can be any string, but using travis\-ci or travis\-pro will allow Coveralls to fetch branch data, comment on pull requests, and more\.
.
.SH "FILES"
\fI\.coveralls\.yml\fR
.
.P
Coveralls configuration file for Ruby\. See \fBCONFIGURATION\fR\.
.
.SH "SEE ALSO"
For more information, you may visit Coveralls web site: \fIhttps://coveralls\.io/\fR or \fIhttps://coveralls\.io/docs/ruby\fR\.
.
.P
This manual page was generated from Markdown with \fBronn(1)\fR \fIhttp://rtomayko\.github\.com/ronn/ronn\.1\.html\fR
.
.SH "AUTHOR"
Coveralls was written by Wil Gieseler \fIsupapuerco@gmail\.com\fR, with contributions from the community\.
.
.SH "DOCUMENTATION"
This manual page was written by Miguel Landaeta \fInomadium@debian\.org\fR\.
.
.SH "LICENSE"
Both Coveralls and this documentation are released under the terms of the MIT License\. You may view the license online: \fIhttps://github\.com/lemurheavy/coveralls\-ruby/blob/master/LICENSE\fR