Configuration

# Aliases

Shortcuts for dash commands you run often.

Aliases are shortcuts for Kamal commands.

For example, for a Rails app, you might open a console with:

```shell
dash app exec -i --reuse "bin/rails console"
```

By defining an alias, like this:

```yaml
aliases:
  console: app exec -i --reuse "bin/rails console"
```

You can now open the console with:

```shell
dash console
```

## Configuring aliases

Aliases are defined in the root config under the alias key.

Each alias is named and can only contain lowercase letters, numbers, dashes, and underscores:

```yaml
aliases:
  uname: app exec -p -q -r web "uname -a"
```

Aliases can include a destination with the `-d` flag:

```yaml
staging_deploy: deploy -d staging
```

> **Note:** Generated from the gem's `lib/dash/configuration/docs/alias.yml` — the same reference `dash docs alias` prints in your terminal, so this page always matches your installed version.