The Travis Client

Table of Contents

Command Line Client

Non-API Commands

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

help

$travishelphelpUsage: travis help [command] [options]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions

version

General API Commands

-e, --api-endpoint URL           Travis API server to talk to    --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'    --pro                        short-cut for --api-endpoint 'https://api.travis-ci.com/'    --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'-t, --token [ACCESS_TOKEN]       access token to use    --debug                      show API requests    --adapter ADAPTER            Faraday adapter to use for HTTP requests

$travis show --adapter net-http...$gem install excon...$travis show --adapter excon...

accounts

$travis accountsrkh (Konstantin Haase): subscribed, 160 repositoriessinatra (Sinatra): subscribed, 9 repositoriesrack (Official Rack repositories): subscribed, 3 repositoriestravis-ci (Travis CI): subscribed, 57 repositories...

console

$travis console>> User.current=> #<User: rkh>>> Repository.find('sinatra/sinatra')=> #<Repository: sinatra/sinatra>>> _.last_build=> #<Travis::Client::Build: sinatra/sinatra#360>

Interactive shell; requires `pry`.Usage: travis console [OPTIONS]-h, --help                       Display help-i, --[no-]interactive           be interactive and colorful-E, --[no-]explode               don't rescue exceptions    --skip-version-check         don't check if travis client is up to date    --skip-completion-check      don't check if auto-completion is set up-e, --api-endpoint URL           Travis API server to talk to-I, --[no-]insecure              do not verify SSL certificate of API endpoint    --pro                        short-cut for --api-endpoint 'https://api.travis-ci.com/'    --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'    --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'    --staging                    talks to staging system-t, --token [ACCESS_TOKEN]       access token to use    --debug                      show API requests    --debug-http                 show HTTP(S) exchange-X, --enterprise [NAME]          use enterprise setup (optionally takes name for multiple setups)    --adapter ADAPTER            Faraday adapter to use for HTTP requests-x, --eval LINE                  run line of ruby

endpoint

$travis endpointAPI endpoint: https://api.travis-ci.org/

$curl"$(travis endpoint)/docs"> docs.html

$travis endpoint --com --set-defaultAPI endpoint: https://api.travis-ci.com/ (stored as default)

$travis endpoint --drop-defaultdefault API endpoint dropped (was https://api.travis-ci.com/)

login

$travis login --pro --github-token ghp_********Successfully logged in as rkh!

logout

$travislogout --comSuccessfully logged out!

monitor

Usage: travis monitor [options]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions        --skip-version-check         don't check if travis client is up to date    -e, --api-endpoint URL           Travis API server to talk to        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests    -X, --enterprise [NAME]          use enterprise setup (optionally takes name for multiple setups)    -m, --my-repos                   Only monitor my own repositories    -r, --repo SLUG                  monitor given repository (can be used more than once)    -R, --store-repo SLUG            like --repo, but remembers value for current directory    -n, --[no-]notify [TYPE]         send out desktop notifications (optional type: osx, growl, libnotify)    -b, --builds                     only monitor builds, not jobs    -p, --push                       monitor push events    -P, --pull                       monitor pull request events

$travis monitorMonitoring travis-ci.org:2013-08-05 01:22:40 questmaster/FATpRemote#45 started2013-08-05 01:22:40 questmaster/FATpRemote#45.1 started2013-08-05 01:22:41 grangier/python-goose#33.1 passed2013-08-05 01:22:42 plataformatec/simple_form#666 passed...

$travis monitorMonitoring travis-ci.org:2013-08-05 01:22:40 questmaster/FATpRemote#45 started2013-08-05 01:22:42 plataformatec/simple_form#666 passed...

$travis monitor --com -nMonitoring travis-ci.com:...

raw

$travis raw /repos/travis-ci/travis.rb{"repo"=>  {"id"=>409371,   "slug"=>"travis-ci/travis.rb",   "description"=>"Travis CI Client (CLI and Ruby library)",   "last_build_id"=>4251410,   "last_build_number"=>"77",   "last_build_state"=>"passed",   "last_build_duration"=>351,   "last_build_language"=>nil,   "last_build_started_at"=>"2013-01-19T18:00:49Z",   "last_build_finished_at"=>"2013-01-19T18:02:17Z"}}

regenerate-token

$travis regenerate-tokenSuccessfully regenerated the token!

remove-token

$travis remove-tokenSuccessfully removed the access token!

report

$travis report --comSystemRuby:                     Ruby 2.0.0-p195Operating System:         Mac OS X 10.8.5RubyGems:                 RubyGems 2.0.7CLIVersion:                  1.5.8Plugins:                  "travis-as-user", "travis-build", "travis-cli-pr"Auto-Completion:          yesLast Version Check:       2013-11-02 16:25:03 +0100SessionAPI Endpoint:             https://api.travis-ci.com/Logged In:                as "rkh"Verify SSL:               yesEnterprise:               noEndpointspro:                      https://api.travis-ci.com/ (access token, current)org:                      https://api.travis-ci.org/ (access token)Last ExceptionAn error occurred running `travis whoami --com`:    Travis::Client::Error: access denied        from ...For issues with the command line tool, please visit https://github.com/travis-ci/travis.rb/issues.For Travis CI in general, go to https://github.com/travis-ci/travis-ci/issues or email support@travis-ci.com.

repos

Lists repositories the user has certain permissions on.Usage: travis repos [options]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions        --skip-version-check         don't check if travis client is up to date        --skip-completion-check      don't check if auto-completion is set up    -e, --api-endpoint URL           Travis API server to talk to    -I, --[no-]insecure              do not verify SSL certificate of API endpoint        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests    -X, --enterprise [NAME]          use enterprise setup (optionally takes name for multiple setups)        --adapter ADAPTER            Faraday adapter to use for HTTP requests    -m, --match PATTERN              only list repositories matching the given pattern (shell style)    -o, --owner LOGIN                only list repos for a certain owner    -n, --name NAME                  only list repos with a given name    -a, --active                     only list active repositories    -A, --inactive                   only list inactive repositories    -d, --admin                      only list repos with (or without) admin access    -D, --no-admin                   only list repos without admin access

$travis repos -m'rkh/travis-*'rkh/travis-chat (active: yes, admin: yes, push: yes, pull: yes)Description: example app demoing travis-sso usagerkh/travis-encrypt (active: yes, admin: yes, push: yes, pull: yes)Description: proof of concept in browser encryption of travis settingsrkh/travis-lite (active: no, admin: yes, push: yes, pull: yes)Description: Travis CI without the JavaScriptrkh/travis-surveillance (active: no, admin: yes, push: yes, pull: yes)Description: Veille sur un projet.

$travis repos --active --owner travis-ci| xargs -I % travis disable -r %travis-ci/artifacts: disabled :(travis-ci/canary: disabled :(travis-ci/docs-travis-ci-com: disabled :(travis-ci/dpl: disabled :(travis-ci/gh: disabled :(...

sync

Usage: travis sync [options]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions    -e, --api-endpoint URL           Travis API server to talk to        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests    -c, --check                      only check the sync status    -b, --background                 will trigger sync but not block until sync is done    -f, --force                      will force sync, even if one is already running

$travis syncsynchronizing: ........... done

$travis sync --backgroundstarting synchronization

$travis sync --checkrkh is currently syncing

lint

$travis lintWarnings for .travis.yml:[x] your repository must be feature flagged for the os setting to be used

$travis lint example.yml...

$echo"foo: bar"| travis lintWarnings for STDIN:[x] unexpected key foo, dropping[x] missing key language, defaulting to ruby

$travis lint -qx||echo".travis.yml does not validate"

token

$travis tokenYour access token is super-secret

$curl -H"Authorization: token$(travis token)" https://api.travis-ci.org/users/{"login":"rkh","name":"Konstantin Haase","email":"konstantin.haase@gmail.com","gravatar_id":"5c2b452f6eea4a6d84c105ebd971d2a4","locale":"en","is_syncing":false,"synced_at":"2013-01-21T20:31:06Z"}

whatsup

$travis whatsupmysociety/fixmystreet started: #154eloquent/typhoon started: #228Pajk/apipie-rails started: #84qcubed/framework failed: #21...

$travis whatsup -mtravis-ci/travis.rb passed: #169rkh/dpl passed: #50rubinius/rubinius passed: #3235sinatra/sinatra errored: #619rtomayko/tilt failed: #162ruby-no-kai/rubykaigi2013 passed: #50rack/rack passed: #519...

whoami

$travis whoamiYou are rkh (Konstantin Haase)

$git clone"https://github.com/$(travis whoami)/some_project"

Repository Commands

-h, --help                       Display help-i, --[no-]interactive           be interactive and colorful-E, --[no-]explode               don't rescue exceptions    --skip-version-check         don't check if travis client is up to date    --skip-completion-check      don't check if auto-completion is set up-e, --api-endpoint URL           Travis API server to talk to-I, --[no-]insecure              do not verify SSL certificate of API endpoint    --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'    --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'-t, --token [ACCESS_TOKEN]       access token to use    --debug                      show API requests-X, --enterprise [NAME]          use enterprise setup (optionally takes name for multiple setups)-r, --repo SLUG                  repository to use (will try to detect from current git clone)-R, --store-repo SLUG            like --repo, but remembers value for current directory

branches

$travis brancheshh-add-warning-old-style:                  #35   passed     Add a warning if old-style encrypt is being usedhh-multiline-encrypt:                      #55   passed     Merge branch 'master' into hh-multiline-encryptrkh-show-logs-history:                     #72   passed     regenerate gemspecrkh-debug:                                 #75   passed     what?hh-add-clear-cache-to-global-session:      #135  passed     Add clear_cache(!) to Travis::Namespacehh-annotations:                            #146  passed     Initial annotation supporthh-remove-newlines-from-encrypted-string:  #148  errored    Remove all whitespace from an encrypted stringversion-check:                             #157  passed     check travis version for updates from time to timemaster:                                    #163  passed     add Repository#branches and Repository#branch(name)

cache

Lists or deletes repository caches.Usage: travis cache [options]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions        --skip-version-check         don't check if travis client is up to date        --skip-completion-check      don't check if auto-completion is set up    -e, --api-endpoint URL           Travis API server to talk to    -I, --[no-]insecure              do not verify SSL certificate of API endpoint        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests    -X, --enterprise [NAME]          use enterprise setup (optionally takes name for multiple setups)    -r, --repo SLUG                  repository to use (will try to detect from current git clone)    -R, --store-repo SLUG            like --repo, but remembers value for current directory    -d, --delete                     delete listed caches    -b, --branch BRANCH              only list/delete caches on given branch    -m, --match STRING               only list/delete caches where slug matches given string    -f, --force                      do not ask user to confirm deleting the caches

$travis cacheOn branch master:cache--rvm-2.0.0--gemfile-Gemfile      last modified: 2013-11-04 13:45:44  size: 62.21 MiBcache--rvm-ruby-head--gemfile-Gemfile  last modified: 2013-11-04 13:46:55  size: 62.65 MiBOn branch example:cache--rvm-2.0.0--gemfile-Gemfile      last modified: 2013-11-04 13:45:44  size: 62.21 MiBOverall size of above caches: 187.07 MiB

$travis cache --branch masterOn branch master:cache--rvm-2.0.0--gemfile-Gemfile      last modified: 2013-11-04 13:45:44  size: 62.21 MiBcache--rvm-ruby-head--gemfile-Gemfile  last modified: 2013-11-04 13:46:55  size: 62.65 MiBOverall size of above caches: 124.86 MiB

$travis cache --match 2.0.0On branch master:cache--rvm-2.0.0--gemfile-Gemfile  last modified: 2013-11-04 13:45:44  size: 62.21 MiBOverall size of above caches: 62.21 MiB

$travis cache -b example -m 2.0.0 --deleteDANGER ZONE: Do you really want to delete all caches on branch example that match 2.0.0? |no| yesDeleted the following caches:On branch example:cache--rvm-2.0.0--gemfile-Gemfile  last modified: 2013-11-04 13:45:44  size: 62.21 MiBOverall size of above caches: 62.21 MiB

cancel

$travis cancelbuild #85 has been canceled

$travis cancel 57build #57 has been canceled

$travis cancel 57.1job #57.1 has been canceled

disable

$travis disabletravis-ci/travis.rb: disabled :(

enable

$travisenabletravis-ci/travis.rb: enabled :)

$travisenable -r rkh/testrepository not known to Travis CI (or no access?)triggering sync: ............. donerkh/test: enabled

encrypt

Encrypts values for the .travis.yml.Usage: travis encrypt [ARGS..] [OPTIONS]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions        --skip-version-check         don't check if travis client is up to date        --skip-completion-check      don't check if auto-completion is set up    -e, --api-endpoint URL           Travis API server to talk to    -I, --[no-]insecure              do not verify SSL certificate of API endpoint        --pro                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'        --staging                    talks to staging system    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests        --debug-http                 show HTTP(S) exchange    -X, --enterprise [NAME]          use enterprise setup (optionally takes name for multiple setups)        --adapter ADAPTER            Faraday adapter to use for HTTP requests    -r, --repo SLUG                  repository to use (will try to detect from current git clone)    -R, --store-repo SLUG            like --repo, but remembers value for current directory    -a, --add [KEY]                  adds it to .travis.yml under KEY (default: env.global)    -s, --[no-]split                 treat each line as a separate input    -p, --append                     don't override existing values, instead treat as list    -x, --override                   override existing value

$travis encrypt FOO=barPlease add the following to your .travis.yml file:  secure: "gSly+Kvzd5uSul15CVaEV91ALwsGSU7yJLHSK0vk+oqjmLm0jp05iiKfs08j\n/Wo0DG8l4O9WT0mCEnMoMBwX4GiK4mUmGdKt0R2/2IAea+M44kBoKsiRM7R3\n+62xEl0q9Wzt8Aw3GCDY4XnoCyirO49DpCH6a9JEAfILY/n6qF8="Pro Tip™: You can add it automatically by running with --add.

$cat id_rsa| travis encrypt

$cat .env| travis encrypt --splitPlease add the following to your .travis.yml file:  secure: "KmMdcwTWGubXVRu93/lY1NtyHxrjHK4TzCfemgwjsYzPcZuPmEA+pz+umQBN\n1ZhzUHZwDNsDd2VnBgYq27ZdcS2cRvtyI/IFuM/xJoRi0jpdTn/KsXR47zeE\nr2bFxRqrdY0fERVHSMkBiBrN/KV5T70js4Y6FydsWaQgXCg+WEU="  secure: "jAglFtDjncy4E3upL/RF0ZOcmJ2UMrqHFCLQwU8PBdurhTMBeTw+IO6cXx5z\nU5zqvPYo/ghZ8mMuUhvHiGDM6m6OlMP7+l10VTxH1CoVew2NcQvRdfK3P+4S\nZJ43Hyh/ZLCjft+JK0tBwoa3VbH2+ZTzkRZQjdg54bE16C7Mf1A="Pro Tip: You can add it automatically by running with --add.

$travis encrypt FOO=bar --add

$travis encrypt FOO=bar --add env.matrix

encrypt-file

Encrypts a file and adds decryption steps to .travis.yml.Usage: travis encrypt-file INPUT_PATH [OUTPUT_PATH] [OPTIONS]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions        --skip-version-check         don't check if travis client is up to date        --skip-completion-check      don't check if auto-completion is set up    -e, --api-endpoint URL           Travis API server to talk to    -I, --[no-]insecure              do not verify SSL certificate of API endpoint        --pro                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'        --staging                    talks to staging system    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests        --debug-http                 show HTTP(S) exchange    -X, --enterprise [NAME]          use enterprise setup (optionally takes name for multiple setups)        --adapter ADAPTER            Faraday adapter to use for HTTP requests    -r, --repo SLUG                  repository to use (will try to detect from current git clone)    -R, --store-repo SLUG            like --repo, but remembers value for current directory    -K, --key KEY                    encryption key to be used (randomly generated otherwise)        --iv IV                      encryption IV to be used (randomly generated otherwise)    -d, --decrypt                    decrypt the file instead of encrypting it, requires key and iv    -f, --force                      override output file if it exists    -p, --print-key                  print (possibly generated) key and iv    -w, --decrypt-to PATH            where to write the decrypted file to on the Travis CI VM    -a, --add [STAGE]                automatically add command to .travis.yml (default stage is before_install)

$travis encrypt-file bacon.txtencrypting bacon.txt for rkh/travis-encrypt-file-examplestoring result as bacon.txt.encstoring secure env variables for decryptionPlease add the following to your build script (before_install stage in your .travis.yml, for instance):    openssl aes-256-cbc -K $encrypted_0a6446eb3ae3_key -iv $encrypted_0a6446eb3ae3_key -in bacon.txt.enc -out bacon.txt -dPro Tip: You can add it automatically by running with --add.Make sure to add bacon.txt.enc to the git repository.Make sure not to add bacon.txt to the git repository.Commit all changes to your .travis.yml.

$travis encrypt-file bacon.txt --addencrypting bacon.txt for rkh/travis-encrypt-file-examplestoring result as bacon.txt.encstoring secure env variables for decryptionMake sure to add bacon.txt.enc to the git repository.Make sure not to add bacon.txt to the git repository.Commit all changes to your .travis.yml.

env

Show or modify build environment variables.Usage: travis env list [options]       travis env set name value [options]       travis env unset [names..] [options]       travis env copy [names..] [options]       travis env clear [OPTIONS]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions        --skip-version-check         don't check if travis client is up to date        --skip-completion-check      don't check if auto-completion is set up    -e, --api-endpoint URL           Travis API server to talk to    -I, --[no-]insecure              do not verify SSL certificate of API endpoint        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'        --staging                    talks to staging system    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests    -X, --enterprise [NAME]          use enterprise setup (optionally takes name for multiple setups)        --adapter ADAPTER            Faraday adapter to use for HTTP requests        --as USER                    authenticate as given user    -r, --repo SLUG                  repository to use (will try to detect from current git clone)    -R, --store-repo SLUG            like --repo, but remembers value for current directory    -P, --[no-]public                make new values public    -p, --[no-]private               make new values private    -u, --[no-]unescape              do not escape values    -f, --force                      do not ask for confirmation when clearing out all variables

$travis envset foo bar --public[+] setting environment variable $foo$travis env list#environment variablesfor travis-ci/travis.rbfoo=bar$export foo=foobar$travis env copy foo bar[+] setting environment variable $foo[+] setting environment variable $bar$travis env list#environment variablesfor travis-ci/travis.rbfoo=foobarbar=[secure]$travis envunset foo bar[x] removing environment variable $foo[x] removing environment variable $bar

history

Displays a project's build history.Usage: travis history [options]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions        --skip-version-check         don't check if travis client is up to date        --skip-completion-check      don't check if auto-completion is set up    -e, --api-endpoint URL           Travis API server to talk to    -I, --[no-]insecure              do not verify SSL certificate of API endpoint        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests    -X, --enterprise [NAME]          use enterprise setup (optionally takes name for multiple setups)    -r, --repo SLUG                  repository to use (will try to detect from current git clone)    -R, --store-repo SLUG            like --repo, but remembers value for current directory    -a, --after BUILD                Only show history after a given build number    -p, --pull-request NUMBER        Only show history for the given Pull Request    -b, --branch BRANCH              Only show history for the given branch    -l, --limit LIMIT                Maximum number of history items    -d, --date                       Include date in output        --[no-]all                   Display all history items

$travishistory#77 passed:   master fix name clash#76 failed:   master Merge pull request #11 from travis-ci/rkh-show-logs-history#75 passed:   rkh-debug what?#74 passed:   rkh-debug all tests pass locally and on the travis vm I spin up :(#73 failed:   Pull Request #11 regenerate gemspec#72 passed:   rkh-show-logs-history regenerate gemspec#71 failed:   Pull Request #11 spec fix for (older) rubinius#70 passed:   rkh-show-logs-history spec fix for (older) rubinius#69 failed:   Pull Request #11 strange fix for rubinius#68 failed:   rkh-show-logs-history strange fix for rubinius

$travishistory --limit 2#77 passed:   master fix name clash#76 failed:   master Merge pull request #11 from travis-ci/rkh-show-logs-history

$travishistory --limit 2 --after 76#75 passed:   rkh-debug what?#74 passed:   rkh-debug all tests pass locally and on the travis vm I spin up :(

$travishistory --limit 3 --branch master#77 passed:   master fix name clash#76 failed:   master Merge pull request #11 from travis-ci/rkh-show-logs-history#57 passed:   master Merge pull request #5 from travis-ci/hh-multiline-encrypt

$travishistory --limit 3 --pull-request 5#56 passed:   Pull Request #5 Merge branch 'master' into hh-multiline-encrypt#49 passed:   Pull Request #5 improve output#48 passed:   Pull Request #5 let it generate accessor for line splitting automatically

init

Usage: travis init [language] [file] [options]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions        --skip-version-check         don't check if travis client is up to date    -e, --api-endpoint URL           Travis API server to talk to        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests        --adapter ADAPTER            Faraday adapter to use for HTTP requests    -r, --repo SLUG                  repository to use (will try to detect from current git clone)    -R, --store-repo SLUG            like --repo, but remembers value for current directory    -s, --skip-sync                  don't trigger a sync if the repo is unknown    -f, --force                      override .travis.yml if it already exists    -k, --skip-enable                do not enable project, only add .travis.yml    -p, --print-conf                 print generated config instead of writing to file        --script VALUE               sets script option in .travis.yml (can be used more than once)        --before-script VALUE        sets before_script option in .travis.yml (can be used more than once)        --after-script VALUE         sets after_script option in .travis.yml (can be used more than once)        --after-success VALUE        sets after_success option in .travis.yml (can be used more than once)        --install VALUE              sets install option in .travis.yml (can be used more than once)        --before-install VALUE       sets before_install option in .travis.yml (can be used more than once)        --compiler VALUE             sets compiler option in .travis.yml (can be used more than once)        --otp-release VALUE          sets otp_release option in .travis.yml (can be used more than once)        --go VALUE                   sets go option in .travis.yml (can be used more than once)        --jdk VALUE                  sets jdk option in .travis.yml (can be used more than once)        --node-js VALUE              sets node_js option in .travis.yml (can be used more than once)        --perl VALUE                 sets perl option in .travis.yml (can be used more than once)        --php VALUE                  sets php option in .travis.yml (can be used more than once)        --python VALUE               sets python option in .travis.yml (can be used more than once)        --rvm VALUE                  sets rvm option in .travis.yml (can be used more than once)        --scala VALUE                sets scala option in .travis.yml (can be used more than once)        --env VALUE                  sets env option in .travis.yml (can be used more than once)        --gemfile VALUE              sets gemfile option in .travis.yml (can be used more than once)

$travis init java.travis.yml file created!travis-ci/java-example: enabled :)

$travis init c --compiler clang.travis.yml file created!travis-ci/c-example: enabled :)

logs

$travis logsdisplaying logs for travis-ci/travis.rb#317.1[... more logs ...]Your bundle is complete! Use `bundle show [gemname]` to see where a bundled gem is installed.$bundleexec rake/home/travis/.rvm/rubies/ruby-1.8.7-p371/bin/ruby -S rspec spec -c..............................................................................................................................................................................................................................................................................Finished in 4.46 seconds270 examples, 0 failuresDone. Build script exited with: 0

$travis logs 100.3displaying logs for travis-ci/travis.rb#100.3

$travis logs 100displaying logs for travis-ci/travis.rb#100.1

$travis logs .2displaying logs for travis-ci/travis.rb#317.2

$travis logs ghedisplaying logs for travis-ci/travis.rb#270.1

$travis logs --deleteDANGER ZONE: Do you really want to delete the build log for travis-ci/travis.rb#559.1? |no| yesdeleting log for travis-ci/travis.rb#559.1$travis logs 1.7 --delete"contained confidential data" --forcedeleting log for travis-ci/travis.rb#1.7

open

$travis open

$travis open 56 --print --githubweb view: https://github.com/travis-ci/travis.rb/pull/5

pubkey

$travis pubkeyPublic key for travis-ci/travis.rb:ssh-rsa ...$travis pubkey -r rails/rails> rails.key

$travis pubkey --pemPublic key for travis-ci/travis.rb:-----BEGIN PUBLIC KEY-----...-----END PUBLIC KEY-----

$travis pubkey --fingerprintPublic key for travis-ci/travis.rb:9f:57:01:4b:af:42:67:1e:b4:3c:0f:b6:cd:cc:c0:04

requests

$travis requests -r sinatra/sinatrapush to master accepted (triggered new build)  abc51e2 - Merge pull request #847 from gogotanaka/add_readme_ja  received at: 2014-02-16 09:26:36PR #843 rejected (skipped through commit message)  752201c - Update Spanish README with tense, verb, and word corrections. [ci skip]  received at: 2014-02-16 05:07:16

restart

$travis restartbuild #85 has been restarted

$travis restart 57build #57 has been restarted

$travis restart 57.1job #57.1 has been restarted

settings

$travis settingsSettings for travis-ci/travis.rb:[-] builds_only_with_travis_yml    Only run builds with a .travis.yml[+] build_pushes                   Build pushes[+] build_pull_requests            Build pull requests[-] maximum_number_of_builds       Maximum number of concurrent builds

$travis settings build_pushes build_pull_requestsSettings for travis-ci/travis.rb:[+] build_pushes                   Build pushes[+] build_pull_requests            Build pull requests

$travis settings build_pushes --disableSettings for travis-ci/travis.rb:[-] build_pushes                   Build pushes$travis settings maximum_number_of_builds --set 1Settings for travis-ci/travis.rb:  1 maximum_number_of_builds       Maximum number of concurrent builds

$travis settings -cSettings for travis-ci/travis.rb:Only run builds with a .travis.yml? |yes| noBuild pushes? |no| yesBuild pull requests? |yes|Maximum number of concurrent builds: |1| 5

setup

Usage: travis setup service [options]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions        --skip-version-check         don't check if travis client is up to date    -e, --api-endpoint URL           Travis API server to talk to        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests        --adapter ADAPTER            Faraday adapter to use for HTTP requests    -r, --repo SLUG                  repository to use (will try to detect from current git clone)    -R, --store-repo SLUG            like --repo, but remembers value for current directory    -f, --force                      override config section if it already exists

$travis setup herokuDeploy only from travis-ci/travis-chat? |yes|Encrypt API key? |yes|

show

$travis showBuild #77: fix name clashState:         passedType:          pushCompare URL:   https://github.com/travis-ci/travis.rb/compare/7cc9b739b0b6...39b66ee24abeDuration:      5 min 51 secStarted:       2013-01-19 19:00:49Finished:      2013-01-19 19:02:17#77.1 passed:    45 sec         rvm: 1.8.7#77.2 passed:    50 sec         rvm: 1.9.2#77.3 passed:    45 sec         rvm: 1.9.3#77.4 passed:    46 sec         rvm: 2.0.0#77.5 failed:    1 min 18 sec   rvm: jruby (failure allowed)#77.6 passed:    1 min 27 sec   rvm: rbx

$travis show 1Build #1: add .travis.ymlState:         failedType:          pushCompare URL:   https://github.com/travis-ci/travis.rb/compare/ad817bc37c76...b8c5d3b463e2Duration:      3 min 16 secStarted:       2013-01-13 23:15:22Finished:      2013-01-13 23:21:38#1.1 failed:     21 sec         rvm: 1.8.7#1.2 failed:     34 sec         rvm: 1.9.2#1.3 failed:     24 sec         rvm: 1.9.3#1.4 failed:     52 sec         rvm: 2.0.0#1.5 failed:     38 sec         rvm: jruby#1.6 failed:     27 sec         rvm: rbx

$travis show rkh-debugBuild #75: what?State:         passedType:          pushBranch:        rkh-debugCompare URL:   https://github.com/travis-ci/travis.rb/compare/8d4aa5254359...7ef33d5e5993Duration:      6 min 16 secStarted:       2013-01-19 18:51:17Finished:      2013-01-19 18:52:43#75.1 passed:    1 min 10 sec   rvm: 1.8.7#75.2 passed:    51 sec         rvm: 1.9.2#75.3 passed:    36 sec         rvm: 1.9.3#75.4 passed:    48 sec         rvm: 2.0.0#75.5 failed:    1 min 26 sec   rvm: jruby (failure allowed)#75.6 passed:    1 min 25 sec   rvm: rbx

$travis show 77.3Job #77.3: fix name clashState:         passedType:          pushCompare URL:   https://github.com/travis-ci/travis.rb/compare/7cc9b739b0b6...39b66ee24abeDuration:      45 secStarted:       2013-01-19 19:00:49Finished:      2013-01-19 19:01:34Allow Failure: falseConfig:        rvm: 1.9.3

sshkey

Checks, updates or deletes an SSH key.Usage: travis sshkey [OPTIONS]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions    -e, --api-endpoint URL           Travis API server to talk to    -I, --[no-]insecure              do not verify SSL certificate of API endpoint        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests    -X, --enterprise [NAME]          use enterprise setup (optionally takes name for multiple setups)    -r, --repo SLUG                  repository to use (will try to detect from current git clone)    -R, --store-repo SLUG            like --repo, but remembers value for current directory    -D, --delete                     remove SSH key    -d, --description DESCRIPTION    set description    -u, --upload FILE                upload key from given file    -s, --stdin                      upload key read from stdin    -c, --check                      set exit code depending on key existing    -g, --generate                   generate SSH key and set up for given GitHub user    -p, --passphrase PASSPHRASE      pass phrase to decrypt with when using --upload

$travis sshkeyNo custom SSH key installed.

$travis sshkey --upload~/.ssh/id_rsaKey description: Test Keyupdating ssh key for travis-pro/test-project with key from /Users/konstantin/.ssh/id_rsaCurrent SSH key: Test Key

$travis sshkey --deleteDANGER ZONE: Remove SSH key for travis-pro/test-project? |no| yesremoving ssh key for travis-pro/test-projectNo custom SSH key installed.

$travis sshkey --generateWe need the GitHub login for the account you want to add the key to.This information will not be sent to Travis CI, only to api.github.com.The password will not be displayed.Username: travisbotPassword for travisbot: **************Generating RSA key.Uploading public key to GitHub.Uploading private key to Travis CI.

status

Usage: travis status [options]    -h, --help                       Display help    -i, --[no-]interactive           be interactive and colorful    -E, --[no-]explode               don't rescue exceptions    -e, --api-endpoint URL           Travis API server to talk to        --com                        short-cut for --api-endpoint 'https://api.travis-ci.com/'        --org                        short-cut for --api-endpoint 'https://api.travis-ci.org/'    -t, --token [ACCESS_TOKEN]       access token to use        --debug                      show API requests    -r, --repo SLUG                  repository to use (will try to detect from current git clone)    -R, --store-repo SLUG            like --repo, but remembers value for current directory    -x, --[no-]exit-code             sets the exit code to 1 if the build failed    -q, --[no-]quiet                 does not print anything    -p, --[no-]fail-pending          sets the status code to 1 if the build is pending

$travis status -qpx&& cap deploy

Travis CI and Travis CI Enterprise

$travis login --com...$travis monitor --com -m...

$travis whatsup --api-endpoint http://localhost:3000...

$travis login -XEnterprise domain: travisci.example.com...$travis whatsup -X...

Environment Variables

Desktop Notifications

Plugins

Official Plugins

Ruby Library

require'travis'rails=Travis::Repository.find('rails/rails')puts"oh no"unlessrails.green?

require'travis/client'client=Travis::Client.newrails=client.repo('rails/rails')puts"oh no"unlessrails.green?

Travis.clear_cacheclient.clear_cache

Authentication

require'travis'Travis.access_token="..."puts"Hello#{Travis::User.current.name}!"

require'travis/client'client=Travis::Client.new(access_token:"...")puts"Hello#{client.user.name}"

require'travis'Travis.github_auth("...")puts"Hello#{Travis::User.current.name}!"

require'travis/auto_login'puts"Hello#{Travis::User.current.name}!"

Using Pro

require'travis/pro'Travis::Pro.access_token='...'user=Travis::Pro::User.currentputs"Hello#{user.name}!"

require'travis/pro/auto_login'puts"Hello#{Travis::Pro::User.current.name}!"

Entities

rails=Travis::Repository.find('rails/rails')sleep1.hourrails.reload

rails.load

Stateful Entities

require'travis'build=Travis::Repository.find('rails/rails').last_buildpbuild.canceled?pbuild.created?pbuild.errored?pbuild.failed?pbuild.finished?pbuild.green?pbuild.passed?pbuild.pending?pbuild.queued?pbuild.red?pbuild.running?pbuild.started?pbuild.successful?pbuild.unsuccessful?pbuild.yellow?pbuild.color

Repositories

require'travis'Travis::Repository.find('rails/rails')# find by slugTravis::Repository.find(891)# find by idTravis::Repository.find_all(owner_name:'rails')# all repos in the rails organizationTravis::Repository.current# repos that see some action right now# all repos with the same owner as the repo with id 891Travis::Repository.find(891).owner.repositories

require'travis'Travis::Repository.find('rails/rails')putsrepo.encrypt('FOO=bar')

rails.disablesystem"push all the things"rails.enable

Builds

require'travis'rails=Travis::Repository.find('rails/rails')rails.last_build# the latest buildrails.recent_builds# the last 20 or so builds (don't rely on that number)rails.builds(after_number:42)# the last 20 or so builds *before* 42rails.build(42)# build with the number 42 (not the id!)rails.builds# Enumerator for #each_build# this will loop through all buildsrails.each_builddo |build|puts"#{build.number}:#{build.state}"end# this will loop through all builds before build 42rails.each_build(after_number:42)do |build|puts"#{build.number}:#{build.state}"end

build=rails.builds.detect{ |b|b.failed?}puts"Last failing Rails build:#{build.number}"

rails.last_build.restart

rails.last_build.cancel

ifrails.branch('4-0-stable').green?puts"Time for another 4.0.x release!"endcount=rails.branches.sizeputs"#{count} rails branches tested on travis"

Jobs

rails.last_build.jobs.eachdo |job|puts"#{job.number} took#{job.duration} seconds"end

rails.job('5000.1')

rails.job('5000.1').restart

rails.job('5000.1').cancel

Artifacts

require'travis'repo=Travis::Repository.find('travis-ci/travis.rb')job=repo.last_build.jobs.firstputsjob.log.body

putsjob.log.colorized_body

job.log.body{ |chunk|printchunk}

Users

require'travis'Travis.access_token='...'user=Travis::User.currentputs"Hello,#{user.login}! Or should I call you...#{user.name.upcase}!?"

Travis::User.current.sync

Commits

require'travis'repo=Travis::Repository.find('travis-ci/travis.rb')commit=repo.last_build.commitputs"Last tested commit:#{commit.short_sha} on#{commit.branch} by#{commit.author_name} -#{commit.subject}"

Caches

require'travis/pro'Travis::Pro.access_token="MY SECRET TOKEN"repo=Travis::Pro::Repository.find("my/rep")repo.caches.eachdo |cache|puts"#{cache.branch}:#{cache.size}"cache.deleteend

repo.delete_caches(branch:"master",match:"rbx")

Repository Settings

require'travis'Travis.access_token="MY SECRET TOKEN"settings=Travis::Repository.find('my/repo').settingsifsettings.build_pushes?settings.build_pushes=falsesettings.saveend

Build Environment Variables

require'travis'Travis.access_token="MY SECRET TOKEN"env_vars=Travis::Repository.find('my/repo').env_varsenv_vars['foo']='bar'env_vars.upsert('foo','foobar',public:true)env_vars.each{ |var|var.delete}

Dealing with Sessions

require'travis/client/session'session=Travis::Client::Session.newsession.access_token="secret_token"# access token to usesession.api_endpoint="http://localhost:3000/"# api endpoint to talk tosession.github_auth("github_token")# log in with a github tokensession.repos(owner_name:'travis-ci')# all travis-ci/* projectssession.repo('travis-ci/travis.rb')# this projectsession.repo(409371)# same as the one abovesession.build(4266036)# build with id 4266036session.job(4266037)# job with id 4266037session.artifact(42)# artifact with id 42session.log(42)# same as abovesession.user# the current user, if logged insession.restart(session.build(4266036))# restart some buildsession.cancel(session.build(4266036))# cancel some build

require'travis/client/session'session=Travis::Client::Session.newsession.instrumentdo |description,block|time=Time.nowblock.callputs"#{description} took#{Time.now -time} seconds"endsession.connection=Faraday::Connection.newsession.get_raw('/repos/rails/rails')# => {"repo" => {"id" => 891, "slug" => "rails/rails", ...}}session.get('/repos/rails/rails')# => {"repo" => #<Travis::Client::Repository: rails/rails>}session.headers['Foo']='Bar'# send a custom HTTP header with every requestrails=session.find_one(Travis::Client::Repository,'rails/rails')session.find_many(Travis::Client::Repository)# repositories with the latest buildssession.find_one_or_many(Travis::Client::User)# the current user (you could also use find_one here)session.reload(rails)session.reset(rails)# lazy reloadsession.clear_cache# empty cached attributessession.clear_cache!# empty identity map

Listening for Events

require'travis'rails=Travis::Repository.find("rails/rails")sinatra=Travis::Repository.find("sinatra/sinatra")Travis.listen(rails,sinatra)do |stream|stream.on('build:started','build:finished')do |event|# ie "rails/rails just passed"puts"#{event.repository.slug} just#{event.build.state}"endend

Using Namespaces

require'travis/client'MyTravis=Travis::Client::Namespaces.new("http://localhost:3000")MyTravis.access_token="..."MyTravis::Repository.find("foo/bar")

require'travis/client'classMyTravisincludeTravis::Client::Namespaces.newendMyTravis::Repository.find('rails/rails')

Installation

$ ruby -vruby 2.3.0p0 (2015-12-25 revision 53290) [x86_64-linux]

$ gem install travis --no-document

$ gem install travis

$ travis version1.14.0

Note on Ruby 2.3

$ gem install faraday -v 1.0.1

Development Version

$ gem install travis --pre

Running Locally

bundle install # install the dependenciesbundle exec bin/travis a-command # run your command

Updating your Ruby

Mac OS X via Homebrew

$ brew install ruby$ gem update --system

Windows

Other Unix systems

$ sudo apt-get update$ sudo apt-get install ruby

Ruby versioning tools

Troubleshooting

Upgrading from travis-cli

uninitialized constant Faraday::Error::ConnectionFailed

Version History

1.14.0

1.13.0

1.12.0

1.11.1

1.11.0

1.10.1

1.10.0 (September 22, 2020)

1.9.1 (May 19, 2020)

1.9.0 (April 27, 2020)

1.8.13 (April 7, 2020)

1.8.12 (March 23, 2020)

1.8.11 (March 2, 2020)

1.8.10 (May 5, 2019)

1.8.8 (March 3, 2017)

1.8.0 (July 15, 2015)

1.7.7 (May 26, 2015)

1.7.6 (April 08, 2015)

1.7.5 (January 15, 2015)

1.7.4 (November 12, 2014)

1.7.3 (November 10, 2014)

1.7.2 (September 17, 2014)

1.7.1 (August 9, 2014)

1.7.0 (August 5, 2014)

1.6.17 (July 25, 2014)

1.6.16 (July 19, 2014)

1.6.15 (July 18, 2014)

1.6.14 (June 17, 2014)

1.6.13 (June 15, 2014)

1.6.12 (June 12, 2014)

1.6.11 (May 12, 2014)

1.6.10 (April 24, 2014)

1.6.9 (April 9, 2014)

1.6.8 (March 12, 2014)

1.6.7 (January 30, 2014)

1.6.6 (December 16, 2013)

1.6.5 (December 16, 2013)

1.6.4 (December 16, 2013)

1.6.3 (November 27, 2013)

1.6.2 (November 8, 2013)

1.6.1 (November 4, 2013)

1.6.0 (November 4, 2013)

1.5.8 (October 24, 2013)

1.5.7 (October 24, 2013)

1.5.6 (October 22, 2013)

1.5.5 (October 2, 2013)

1.5.4 (September 7, 2013)

1.5.3 (August 22, 2013)

1.5.2 (August 18, 2013)

1.5.1 (August 15, 2013)

1.5.0 (August 7, 2013)

1.4.0 (July 26, 2013)

1.3.1 (July 21, 2013)

1.3.0 (July 20, 2013)

1.2.8 (July 19, 2013)

1.2.7 (July 15, 2013)

v1.2.6 (July 7, 2013)

v1.2.5 (July 7, 2013)

v1.2.4 (July 7, 2013)

v1.2.3 (June 27, 2013)

v1.2.2 (May 24, 2013)

v1.2.1 (May 24, 2013)

v1.2.0 (February 22, 2013)

v1.1.3 (January 26, 2013)

v1.1.2 (January 24, 2013)

v1.1.1 (January 22, 2013)

v1.1.0 (January 21, 2013)

v1.0.3 (January 15, 2013)

v1.0.2 (January 14, 2013)

v1.0.1 (January 14, 2013)

v1.0.0 (January 14, 2013)

v1.0.0pre2 (January 14, 2013)

v1.0.0pre (January 13, 2013)