- Docs »
{% if page %}
{% for doc in page.ancestors %}
{% if doc.link %}
- {{ doc.title }} »
{% else %}
- {{ doc.title }} »
{% endif %}
{% endfor %}
{% endif %}
{% if page %}- {{ page.title }}
{% endif %}
-
{%- block repo %}
{% if page and page.edit_url %}
{%- if "edit_url" in page.meta: %}
Edit on {{ config.repo_name }}
{%- else %}
Edit on {{ config.repo_name }}
{%- endif %}
{% endif %}
{%- endblock %}
{% if config.theme.prev_next_buttons_location|lower in ['top', 'both']
and page and (page.next_page or page.previous_page) %}
{% endif %}
mattbrictson-tomo-4f4e9a6/custom_theme/main.html 0000664 0000000 0000000 00000000244 15271266644 0022146 0 ustar 00root root 0000000 0000000 {% extends "base.html" %}
{% block extrahead %}
{% endblock %}
mattbrictson-tomo-4f4e9a6/docs/ 0000775 0000000 0000000 00000000000 15271266644 0016570 5 ustar 00root root 0000000 0000000 mattbrictson-tomo-4f4e9a6/docs/CNAME 0000664 0000000 0000000 00000000026 15271266644 0017334 0 ustar 00root root 0000000 0000000 tomo.mattbrictson.com
mattbrictson-tomo-4f4e9a6/docs/api/ 0000775 0000000 0000000 00000000000 15271266644 0017341 5 ustar 00root root 0000000 0000000 mattbrictson-tomo-4f4e9a6/docs/api/Host.md 0000664 0000000 0000000 00000001360 15271266644 0020600 0 ustar 00root root 0000000 0000000 # Tomo::Host
Represents a remote SSH host.
```ruby
host.address # => "example.com"
host.port # => 22
host.user # => "deployer"
host.roles # => ["app", "db"]
host.to_s # => "deployer@example.com"
```
A Host is always frozen and cannot be modified.
## Instance methods
### address β String
The host name or IP address.
### port β Integer
The SSH port, usually 22.
### user β String
The username used when connecting to the host via SSH.
### roles β [String]
An array of roles that are assigned to this host. Roles are used in multi-host deployments to control which tasks are run on which hosts.
### to_s β String
A representation of host in the form of `user@address:port`. If the port is 22, that portion is omitted.
mattbrictson-tomo-4f4e9a6/docs/api/Logger.md 0000664 0000000 0000000 00000003635 15271266644 0021111 0 ustar 00root root 0000000 0000000 # Tomo::Logger
Provides a simple interface for logging messages to stdout and stderr. In multi-host deployments, messages are automatically prefixed with `[1]`, `[2]`, etc. based on current host. This makes it easier to distinguish where log messages are coming from.
```
$ tomo run bundler:clean
tomo run v1.0.0
[1] β Connecting to deployer@web1.example.com
[2] β Connecting to deployer@web2.example.com
[1] β’ bundler:clean
[2] β’ bundler:clean
[1] cd /home/deployer/apps/my-app/current && bundle clean
[2] cd /home/deployer/apps/my-app/current && bundle clean
β Ran bundler:clean on deployer@web1.example.com and deployer@web2.example.com
```
If tomo is run in `--dry-run` mode, log messages are prefixed with a `*` to indicate the commands are being simulated.
```
$ tomo run bundler:clean --dry-run
tomo run v1.0.0
* [1] β Connecting to deployer@web1.example.com
* [2] β Connecting to deployer@web2.example.com
* [1] β’ bundler:clean
* [2] β’ bundler:clean
* [1] cd /home/deployer/apps/my-app/current && bundle clean
* [2] cd /home/deployer/apps/my-app/current && bundle clean
* Simulated bundler:clean on deployer@web1.example.com and deployer@web2.example.com (dry run)
```
If tomo is run with the `--quiet` option, all progress messages and info messages are silenced. Script output, warnings, and errors are still printed.
```
$ tomo run bundler:install --quiet
The Gemfile's dependencies are satisfied
```
## Instance methods
### debug(message) β nil
Prints a message to _stderr_ in gray with a `DEBUG:` prefix. Debug messages are only shown if tomo is run with the `--debug` option. Otherwise this is a no-op.
### info(message) β nil
Prints a message to _stdout_.
### warn(message) β nil
Prints a message to _stderr_ with a red `WARNING:` prefix.
### error(message) β nil
Prints a message to _stderr_ with a red `ERROR:` prefix, indented, and with leading and trailing blank lines for extra emphasis.
mattbrictson-tomo-4f4e9a6/docs/api/Paths.md 0000664 0000000 0000000 00000003554 15271266644 0020751 0 ustar 00root root 0000000 0000000 # Tomo::Paths
Provides syntactic sugar for accessing settings that represent file system paths. For every tomo setting in the form `: