mirror of
https://github.com/gravitational/teleport.git
synced 2026-09-19 11:00:37 +08:00
Paul Gottschling
d5729566eb
Reduce repetition in order to make the sidebar easier to read. This change edits labels in the following sidebar sections: - reference/agent-services/database-access-reference - reference/agent-services/desktop-access-reference - reference/agent-services - reference/architecture - reference/deployment - reference/machine-workload-identity/workload-identity - reference
85 lines
2.8 KiB
Plaintext
85 lines
2.8 KiB
Plaintext
---
|
|
title: Command-Line Tool References
|
|
sidebar_label: Command-Line Tools
|
|
description: Detailed guide and reference documentation for Teleport's command line interface (CLI) tools.
|
|
tags:
|
|
- reference
|
|
- platform-wide
|
|
---
|
|
|
|
Teleport is made up of six CLI tools.
|
|
|
|
- [teleport](teleport.mdx): Supports the Teleport Infrastructure Identity Platform by starting and configuring various Teleport services.
|
|
- [teleport-update](teleport-update.mdx): Installs and updates Teleport binaries.
|
|
- [tsh](tsh.mdx): Allows end users to authenticate to Teleport and access resources in a cluster.
|
|
- [tctl](tctl.mdx): Used to configure the Teleport Auth Service.
|
|
- [tbot](tbot.mdx): Supports Machine & Workload Identity, which provides short lived credentials to service accounts (e.g, a CI/CD server).
|
|
- [fdpass-teleport](fdpass-teleport.mdx): Supports integrating Machine & Workload Identity with OpenSSH for higher performance SSH connections.
|
|
|
|
(!docs/pages/includes/permission-warning.mdx!)
|
|
|
|
<details>
|
|
<summary>Improve the CLI experience: enable shell completion</summary>
|
|
|
|
Teleport's CLI tools can provide completion hints for bash and zsh.
|
|
For example, typing `tsh` and pressing `Tab` will show all available
|
|
subcommands, typing `tsh --` and pressing `Tab` will show all available flags.
|
|
|
|
To enable completion, add an additional statement to your shell configuration file.
|
|
|
|
Example (`.bashrc`):
|
|
|
|
```sh
|
|
eval "$(tsh --completion-script-bash)"
|
|
```
|
|
|
|
Example (`.zshrc`):
|
|
|
|
```sh
|
|
# enable completion feature
|
|
autoload -Uz compinit
|
|
compinit
|
|
|
|
eval "$(tsh --completion-script-zsh)"
|
|
```
|
|
|
|
Reload your shell to see the changes.
|
|
|
|
You can repeat the same process for `tctl`, `teleport`, and `tbot`.
|
|
|
|
</details>
|
|
|
|
(!docs/pages/includes/backup-warning.mdx!)
|
|
|
|
## Resource filtering
|
|
|
|
Both `tsh` and `tctl` allow you to filter servers, applications, databases,
|
|
desktops, and Kubernetes clusters using the `--search` and `--query` flags.
|
|
|
|
The `--search` flag performs a simple fuzzy search on resource fields. For example, `--search=mac` searches for resources containing `mac`.
|
|
|
|
The `--query` flag allows you to perform more sophisticated searches using a [predicate language](../access-controls/predicate-language.mdx).
|
|
|
|
In both cases, you can further refine the results by appending a list of comma-separated labels to the command. For example:
|
|
|
|
```code
|
|
$ tsh ls --search=foo,bar labelKey1=labelValue1,labelKey2=labelValue2
|
|
```
|
|
|
|
### Filter Examples
|
|
|
|
```code
|
|
# List all nodes
|
|
$ tsh ls
|
|
|
|
# List nodes using label argument
|
|
$ tsh ls env=staging,os=mac
|
|
|
|
# List nodes using search keywords
|
|
$ tsh ls --search=staging,mac
|
|
|
|
# List nodes using predicate language. This query searches for nodes with labels
|
|
# with key `env` equal to `staging` and key `os` equal to `mac`.
|
|
$ tsh ls --query='labels["env"] == "staging" && equals(labels["os"], "mac")'
|
|
```
|