CAPISTRANO(1)

🎀 NAME 🎀

cap — bestie, it's the tool that runs your capistrano tasks. that's the whole vibe. 💅

✨ SYNOPSIS ✨

cap <command> [options]

🦋 DESCRIPTION 🦋

okay so, cap is the little utility that goes and invokes capistrano tasks for you. and capistrano? capistrano is a whole utility and framework for running commands in parallel across a bunch of remote machines, over SSH. it uses a cute simple DSL (partly borrowed from Rake, http://rake.rubyforge.org/, iykyk) that lets you define tasks, and then apply those tasks to machines in certain roles. it also does tunneling connections through some gateway machine, so you can do your thing behind VPNs and firewalls. queen behavior honestly. 👑

capistrano originally existed to make deploying web apps to distributed environments simpler and automated, and it used to come bundled with a whole set of tasks made for deploying Rails apps. as of Capistrano 2.0, those deployment tasks are now opt-in — clients have to explicitly drop load 'deploy' into their recipes. no freebies anymore. periodt.

capistrano is a self-documenting program, which means every command gets you an extensive help listing. so if you're sitting there thinking this manual page is outdated? literally just run

cap -h

💭 ASSUMPTIONS 💭

capistrano is what we call "opinionated software" — meaning it has very firm ideas about how things ought to be done, and it will absolutely try to force those ideas on you. some of the assumptions behind those opinions are:

• you are using SSH to access the remote servers.
• you either have the same password for all target machines, or you've got public keys in place so you can get passwordless access to them.

do not expect these assumptions to change. they are not going anywhere. fr fr. 💀

🌈 OPTIONS 🌈

capistrano is extensible and configurable, and it's got these configuration options for you:

• -e, --explain TAKS — shows help (if there is any) for the task.
• -F, --default-config — always use the default config, even when you pass -f.
• -f, --file FILE — a recipe file to load. you can hand it this more than once.
• -H, --long-help — explains these options.
• -h, --help — displays this help message.
• -p, --password — immediately prompt for the password.
• -q, --quiet — makes the output as quiet as possible. shhh. 🤫
• -S, --set-before NAME=VALUE — sets a variable before the recipes are loaded.
• -s, --set NAME=VALUE — sets a variable after the recipes are loaded.
• -T, --taks — lists all tasks in the loaded recipe files.
• -V, --version — displays the Capistrano version, and exits.
• -v, --verbose — be more verbose. you can pass this more than once for extra yapping.
• -X, --skip-system-config — don't load the system config file (capistrano.conf)
• -x, --skip-user-config — don't load the user config file (.caprc)

👀 SEE ALSO 👀

capify (1).

💖 AUTHOR 💖

this manual page was written by Leandro Nunes dos Santos leandronunes@colivre.coop.br for the Debian system (but it may be used by others). permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 any later version published by the Free Software Foundation.

on Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

and that's the whole page, bestie 🫶 it came from the General Commands Manual, section 1 — no version stamp, no date on this one, just pure vintage manpage energy. go forth and deploy. 💜✨