aliases

Map custom aliases to full Kamal command strings in config/deploy.yml.

Updated Jun 30, 2026
One-click install
npx skills add https://github.com/donnfelker/kamal-skills --skill aliases
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: aliases
Source: https://github.com/donnfelker/kamal-skills/tree/main/skills/aliases
Command: npx skills add https://github.com/donnfelker/kamal-skills --skill aliases

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill eliminates the need to repeatedly type long, complex Kamal commands by allowing you to define short, memorable aliases directly in your deployment configuration.

Core Features & Use Cases

  • Command Shortcutting: Map complex command strings to simple, single-word aliases.
  • Environment Optimization: Create destination-specific shortcuts like staging_deploy to prevent configuration errors.
  • Use Case: If you frequently run a Rails console in your production container, you can define a console alias that expands to the full app exec command, allowing you to launch your environment with a single word.

Quick Start

Add a new alias for your most frequently used command by editing the aliases section in your config/deploy.yml file.

Frequently Asked Questions about aliases

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create custom Kamal shortcuts for repetitive deployment commands?

Create custom Kamal shortcuts by mapping short, memorable aliases to full command strings within the aliases key of your config/deploy.yml file. This eliminates the need to repeatedly type complex commands for routine deployment tasks.

Can I configure environment-specific Kamal aliases to prevent staging and production deployment errors?

Yes, you can configure environment-specific Kamal aliases like staging_deploy to prevent configuration errors. Mapping destination-specific shortcuts in your config/deploy.yml ensures you target the correct server role before executing maintenance commands.

How do I set up a Rails console shortcut for my production container using Kamal?

Set up a Rails console shortcut by defining a console alias in the aliases section of config/deploy.yml. This alias expands to the full Kamal app exec command, allowing you to launch your production environment with a single word.

What structure do I need to follow when adding aliases to my Kamal deployment configuration?

You must follow the documented naming conventions and the structure of the aliases key in config/deploy.yml. Adhering to this configuration structure ensures your custom command shortcuts execute correctly across various server roles and destinations.

Does the aliases Skill require any external dependencies to map Kamal commands?

No, the aliases Skill requires no external dependencies to map Kamal commands. It relies entirely on editing the existing aliases section within your project's config/deploy.yml file to simplify command execution.