<commit_before># The Travis Client

[![Build Status](https://travis-ci.org/travis-ci/travis.png?branch=master)](https://travis-ci.org/travis-ci/travis)

The [travis gem](https://rubygems.org/gems/travis) includes both a [command line client](#command-line-client) and a [Ruby library](#ruby-library) to interface with a Travis CI service. Both work with [travis-ci.org](https://travis-ci.org), [travis-ci.com](https://travis-ci.com) or any custom Travis CI setup you might have. Check out the [installation instructions](#installation) to get it running in no time.

## Table of Contents

* [Command Line Client](#command-line-client)
    * [Non-API Commands](#non-api-commands)
        * [`help`](#help)
        * [`version`](#version)
    * [General API Commands](#general-api-commands)
        * [`console`](#console)
        * [`endpoint`](#endpoint)
        * [`login`](#login)
        * [`raw`](#raw)
        * [`sync`](#sync)
        * [`token`](#token)
        * [`whatsup`](#whatsup)
        * [`whoami`](#whoami)
    * [Repository Commands](#repository-commands)
        * [`branches`](#branches)
        * [`disable`](#disable)
        * [`enable`](#enable)
        * [`encrypt`](#encrypt)
        * [`history`](#history)
        * [`init`](#init)
        * [`logs`](#logs)
        * [`open`](#open)
        * [`pubkey`](#pubkey)
        * [`restart`](#restart)
        * [`setup`](#setup)
        * [`show`](#show)
        * [`status`](#status)
* [Ruby Library](#ruby-library)
    * [Authentication](#authentication)
    * [Using Pro](#using-pro)
    * [Entities](#entities)
        * [Stateful Entities](#stateful-entities)
        * [Repositories](#repositories)
        * [Builds](#builds)
        * [Jobs](#jobs)
        * [Artifacts](#artifacts)
        * [Users](#users)
        * [Commits](#commits)
        * [Workers](#workers)
    * [Dealing with Sessions](#dealing-with-sessions)
    * [Using Namespaces](#using-namespaces)
* [Installation](#installation)
    * [Updating your Ruby](#updating-your-ruby)
        * [Mac OSX via Homebrew](#mac-osx-via-homebrew)
        * [Windows](#windows)
        * [Other Unix systems](#other-unix-systems)
        * [Ruby versioning tools](#ruby-versioning-tools)
    * [Upgrading from travis-cli](#upgrading-from-travis-cli)
* [Version History](#version-history)

## Command Line Client

There are three types of commands: [Non-API Commands](#non-api-commands), [General API Commands](#general-api-commands) and [Repository Commands](#repository-commands). All commands take the form of `travis COMMAND [ARGUMENTS] [OPTIONS]`. You can get a list of commands by running [`help`](#help).

### Non-API Commands

Every Travis command takes three global options:

    -h, --help                       Display help
    -i, --[no-]interactive           be interactive and colorful
    -E, --[no-]explode               don't rescue exceptions

The `--help` option is equivalent to running `travis help COMMAND`.

The `--interactive` options determines wether to include additional information and colors in the output or not (except on Windows, we never display colors on Windows, sorry). If you don't set this option explicitly, you will run in interactive mode if you invoke the command directly in a shell and in non-interactive mode if you pipe it somewhere.

You probably want to use `--explode` if you are working on a patch for the Travis client, as it will give you the Ruby exception instead of a nice error message.
<commit_msg>add some images [ci skip]<commit_after># The Travis Client

[![Build Status](https://travis-ci.org/travis-ci/travis.png?branch=master)](https://travis-ci.org/travis-ci/travis)

![The Travis Mascot](http://about.travis-ci.org/images/travis-mascot-200px.png)

The [travis gem](https://rubygems.org/gems/travis) includes both a [command line client](#command-line-client) and a [Ruby library](#ruby-library) to interface with a Travis CI service. Both work with [travis-ci.org](https://travis-ci.org), [travis-ci.com](https://travis-ci.com) or any custom Travis CI setup you might have. Check out the [installation instructions](#installation) to get it running in no time.

## Table of Contents

* [Command Line Client](#command-line-client)
    * [Non-API Commands](#non-api-commands)
        * [`help`](#help)
        * [`version`](#version)
    * [General API Commands](#general-api-commands)
        * [`console`](#console)
        * [`endpoint`](#endpoint)
        * [`login`](#login)
        * [`raw`](#raw)
        * [`sync`](#sync)
        * [`token`](#token)
        * [`whatsup`](#whatsup)
        * [`whoami`](#whoami)
    * [Repository Commands](#repository-commands)
        * [`branches`](#branches)
        * [`disable`](#disable)
        * [`enable`](#enable)
        * [`encrypt`](#encrypt)
        * [`history`](#history)
        * [`init`](#init)
        * [`logs`](#logs)
        * [`open`](#open)
        * [`pubkey`](#pubkey)
        * [`restart`](#restart)
        * [`setup`](#setup)
        * [`show`](#show)
        * [`status`](#status)
* [Ruby Library](#ruby-library)
    * [Authentication](#authentication)
    * [Using Pro](#using-pro)
    * [Entities](#entities)
        * [Stateful Entities](#stateful-entities)
        * [Repositories](#repositories)
        * [Builds](#builds)
        * [Jobs](#jobs)
        * [Artifacts](#artifacts)
        * [Users](#users)
        * [Commits](#commits)
        * [Workers](#workers)
    * [Dealing with Sessions](#dealing-with-sessions)
    * [Using Namespaces](#using-namespaces)
* [Installation](#installation)
    * [Updating your Ruby](#updating-your-ruby)
        * [Mac OSX via Homebrew](#mac-osx-via-homebrew)
        * [Windows](#windows)
        * [Other Unix systems](#other-unix-systems)
        * [Ruby versioning tools](#ruby-versioning-tools)
    * [Upgrading from travis-cli](#upgrading-from-travis-cli)
* [Version History](#version-history)

## Command Line Client

![](http://about.travis-ci.org/images/new-tricks.png)

There are three types of commands: [Non-API Commands](#non-api-commands), [General API Commands](#general-api-commands) and [Repository Commands](#repository-commands). All commands take the form of `travis COMMAND [ARGUMENTS] [OPTIONS]`. You can get a list of commands by running [`help`](#help).

### Non-API Commands

Every Travis command takes three global options:

    -h, --help                       Display help
    -i, --[no-]interactive           be interactive and colorful
    -E, --[no-]explode               don't rescue exceptions

The `--help` option is equivalent to running `travis help COMMAND`.

The `--interactive` options determines wether to include additional information and colors in the output or not (except on Windows, we never display colors on Windows, sorry). If you don't set this option explicitly, you will run in interactive mode if you invoke the command directly in a shell and in non-interactive mode if you pipe it somewhere.

You probably want to use `--explode` if you are working on a patch for the Travis client, as it will give you the Ruby exception instead of a nice error message.

{'fraction_non_alphanumeric': 0.15810886644219976, 'fraction_numerical': 0.00042087542087542086, 'mean_word_length': 3.233372921615202, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6753096', 'n_tokens_mistral': 2266, 'n_tokens_neox': 2115, 'n_words': 582}