This is the primary public API for extending tomo.

A TaskLibrary defines tasks. Every public instance method of a TaskLibrary becomes accessible to tomo as a task of the same name, prefixed by the name of its plugin. For example, this is how the git:clone task is defined:

module Tomo::Plugin::Git
  class Tasks < Tomo::TaskLibrary
    # This becomes the implementation of the git:clone task
    def clone
      require_setting :git_url
      # ...

The TaskLibrary base class provides several useful private methods (detailed below) that allow task authors to run commands on the remote host, access tomo settings, and more. For more information on writing tasks, refer to the Writing Custom Tasks tutorial.

Instance methods

paths → Tomo::Paths

Returns a Paths object that provides convenient access to settings representing file system paths.

paths.current.join("lib") # => "/var/www/my-app/current/lib"
# ...which is syntactic sugar for:[:current_path]).join("lib")

settings → Hash

Returns a frozen (i.e. read-only) Hash containing all of tomo’s settings. Any string interpolations will have already been applied. The keys representing the setting names are always symbols.

settings[:application]        # => "my-app"
settings[:deploy_to]          # => "/var/www/my-app"
settings[:non_existing]       # => nil
settings.fetch(:non_existing) # => KeyError
settings[:foo] = "bar"        # => FrozenError
settings.key?(:application)   # => true
settings.key?(:non_existing)  # => false

remote → Tomo::Remote

Returns the Remote façade that allows scripts to be run on the remote host."echo", "hello world")

require_setting(name) → nil

Raises an exception if a setting with the given name is not present. In other words, it will raise if settings[name] is nil. This can be used as a guard clause to ensure that users provide all necessary settings before a task can be run.

def clone
  require_setting :git_url "git", "clone", settings[:git_url]

require_settings(*names) → nil

Like require_setting, except it accepts an arbitrary number of setting names. Raises if any of the settings are nil.

require_settings :puma_control_token, :puma_control_url

merge_template(path) → String

Given a local path to an ERB template, merge that template and return the resulting string. The ERB template can access the same API that tasks and helpers can access, namely: settings, paths, remote, and raw.

Here is an example of an ERB template:

Hello, <%= settings[:application] %>!

If path begins with a "." it is interpreted as a path relative to the tomo configuration file. This allows for easy reference to project-specific templates. For example, given this directory structure:

├── config.rb
└── templates
    └── unicorn.service.erb

Then you could reference the template in a setting like this:

# .tomo/config.rb

set unicorn_service_template_path: "./templates/unicorn.service.erb"

And merge it in a task:


dry_run? → true or false

Returns true if tomo was started with the --dry-run option. This is useful if there are certain code paths you want to ensure are taken during a dry run.

def install
  return if remote.bundle?("check", *check_options) && !dry_run?

  remote.bundle("install", *install_options)

logger → Tomo::Logger

Returns the global Logger object that can be used to write messages to tomo’s output.

logger.debug "got here" "hi!"
logger.warn "uh oh"


Immediately halt task execution by raising an exception. This will automatically print information to stderr about what task failed, on which host, and the reason for the failure.

raw(string) → String

Mark a string as a “raw” value so that it is not automatically escaped. By default tomo applies shell escaping rules for safety. If you explicitly want to invoke shell behavior, use raw to prevent these escaping rules. "ls", "$HOME/.bashrc"
# $ ls $\HOME/.bashrc
# "$HOME/.bashrc": No such file or directory (os error 2) "ls", raw("$HOME/.bashrc")
# $ ls $HOME/.bashrc
# /home/deployer/.bashrc