﻿---
title: stack es cat aliases cli command
description: Get aliases. Behaviour flags: --dry-run — validate all inputs and exit without performing any action 
url: https://www.elastic.co/elastic/docs-builder/docs/4118/reference/elastic-cli/cli/stack/es/cat/aliases
applies_to:
  - Elastic Cloud Serverless: Preview
  - Elastic Stack: Preview
---

# stack es cat aliases cli command
<cli-modifiers>
</cli-modifiers>

```bash
elastic stack es cat aliases [options]
```

Get aliases.
**Behaviour flags:**
`--dry-run` — validate all inputs and exit without performing any action

## Options

<definitions>
  <definition term="--h string">
    A comma-separated list of columns names to display. It supports simple wildcards.
    **Repeatable:** pass `--h` multiple times to supply more than one value
  </definition>
  <definition term="--s string">
    List of columns that determine how the table should be sorted.
    Sorting defaults to ascending and can be changed by setting `:asc`
    or `:desc` as a suffix to the column name.
    **Repeatable:** pass `--s` multiple times to supply more than one value
  </definition>
  <definition term="--expand-wildcards enum">
    The type of index that wildcard patterns can match.
    If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
    It supports comma-separated values, such as `open,hidden`.
    **Values:** all, open, closed, hidden, none
    **Repeatable:** pass `--expand-wildcards` multiple times to supply more than one value
  </definition>
  <definition term="--master-timeout string">
    The period to wait for a connection to the master node.
    If the master node is not available before the timeout expires, the request fails and returns an error.
    To indicated that the request should never timeout, you can set it to `-1`.
  </definition>
  <definition term="--name string">
    A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
    **Repeatable:** pass `--name` multiple times to supply more than one value
  </definition>
  <definition term="--format string">
    Specifies the format to return the columnar data in, can be set to
    `text`, `json`, `cbor`, `yaml`, or `smile`.
  </definition>
  <definition term="--v">
    When set to `true` will enable verbose output.
  </definition>
  <definition term="--bytes enum">
    Sets the units for columns that contain a byte-size value.
    Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes.
    If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
    If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
    Values that are not an exact multiple of the chosen unit are rounded down.
    **Values:** b, kb, mb, gb, tb, pb
  </definition>
  <definition term="--time enum">
    Sets the units for columns that contain a time duration.
    If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`.
    If given, time duration values are rendered as an integer with no suffix.
    Values that are not an exact multiple of the chosen unit are rounded down.
    **Values:** nanos, micros, ms, s, m, h, d
  </definition>
  <definition term="--error-trace">
    When set to `true` Elasticsearch will include the full stack trace of errors
    when they occur.
  </definition>
  <definition term="--filter-path string">
    Comma-separated list of filters in dot notation which reduce the response
    returned by Elasticsearch.
    **Repeatable:** pass `--filter-path` multiple times to supply more than one value
  </definition>
  <definition term="--human">
    When set to `true` will return statistics in a format suitable for humans.
    For example `"exists_time": "1h"` for humans and
    `"exists_time_in_millis": 3600000` for computers. When disabled the human
    readable values will be omitted. This makes sense for responses being consumed
    only by machines.
  </definition>
  <definition term="--pretty">
    If set to `true` the returned JSON will be "pretty-formatted". Only use
    this option for debugging only.
  </definition>
  <definition term="--input-file string">
    path to a JSON file to use as command input
  </definition>
  <definition term="--dry-run">
    validate all inputs and exit without performing any action (preview changes without applying them)
  </definition>
</definitions>


## Global Options

<definitions>
  <definition term="--json">
    output as JSON
  </definition>
</definitions>