summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-completion.1.md
blob: 43409e2825b13b20c225df33b0f95895d6953873 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
% podman-completion(1)

## NAME
podman\-completion - Generate shell completion scripts

## SYNOPSIS
**podman completion** [*options*] *bash*|*zsh*|*fish*

## DESCRIPTION
The completion command allows you to generate shell completion scripts. Supported shells are **bash**, **zsh** and **fish**.

These script are used by the shell to provide suggestions and complete commands when you are typing the command and press [TAB].

Usually these scripts are automatically installed via rpm/deb packages.

## OPTIONS
**--file**, **-f**

Write the generated output to file.

**--no-desc**

Do not provide description in the completions.

## Installation

### BASH
Make sure you have `bash-completion` installed on your system.

To load the completion script into your current session run:
`source <(podman completion bash)`

To make it available in all your bash sessions run:
`podman completion bash -f /etc/bash_completion.d/podman`


### ZSH
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
`echo "autoload -U compinit; compinit" >> ~/.zshrc`

To make it available in all your zsh sessions run:
`podman completion zsh -f "${fpath[1]}/_podman"`

Once you reload the shell the autocompletion should be working.


### FISH
To load the completion script into your current session run:
`podman completion fish | source`

To make it available in all your fish sessions run:
`podman completion fish -f ~/.config/fish/completions/podman.fish`


## SEE ALSO
[podman(1)](podman.1.md)