boundary/website/content/docs/commands/aliases/read.mdx

---
layout: docs
page_title: aliases read - Command
description: >-
  The "aliases read" command retrieves the details of an alias resource.
---

⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
> [!IMPORTANT]  
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

# aliases read

Command: `aliases read`

The `aliases read` command lets you read the details of an alias with a given ID.

## Example

This example reads the details of an alias with the ID `alt_1234567890`:

```shell-session
$ boundary aliases read -id alt_1234567890
```

## Usage

<CodeBlockConfig hideClipboard>

```shell-session
$ boundary aliases read [options] [args]
```

</CodeBlockConfig>

### Command options

- `-id=<string>` - The ID of the alias you want to read.

@include 'cmd-option-note.mdx'