Turbot CLI

Gem Version Build Status Build Status Dependency Status Coverage Status Code Climate

The Turbot CLI is used to manage Turbot bots from the command line.

Getting Started

gem install turbot

You now have access to the turbot command. Log in using your Turbot account's email and password:

$ turbot login
Enter your Turbot email and password.
Email: [email protected]
Password (typing will be hidden):

You can then generate a bot:

turbot bots:generate --bot my_amazing_bot
cd my_amazing_bot

Register the bot with Turbot:

turbot bots:register

Run your bot locally:

turbot bots:dump

Ensure your bot is valid:

turbot bots:validate

And push your code to Turbot when ready:

turbot bots:push

To read about Turbot's other commands:

turbot help

Environment variables

  • TURBOT_API_KEY: Overrides the API key in the .netrc file. Allows you to skip authentication.

  • TURBOT_BOT: Overrides the bot in the current directory, but not the bot set with the --bot option.

  • TURBOT_HOST: Overrides the base URL of the Turbot server, which is http://turbot.opencorporates.com by default.

Releasing a new version

Bump the version in lib/turbot/version.rb according to the Semantic Versioning convention, then:

git commit lib/turbot/version.rb -m 'Release new version'
rake release # requires Rubygems credentials

Based on the Heroku CLI.

Copyright (c) 2015 Chrinon Ltd, released under the MIT license