Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve: fixes docs for cli completion cmd #2942

Merged
merged 1 commit into from
Aug 15, 2022
Merged

improve: fixes docs for cli completion cmd #2942

merged 1 commit into from
Aug 15, 2022

Conversation

kimskimchi
Copy link
Contributor

@kimskimchi kimskimchi commented Aug 15, 2022

Summary

CLI

To load completions:

Bash:

  $ source <(infra completion bash)

  # To load completions for each session, execute once:
  # Linux:
  $ infra completion bash > /etc/bash_completion.d/infra
  # macOS:
  $ infra completion bash > /usr/local/etc/bash_completion.d/infra

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 load completions for each session, execute once:
  $ infra completion zsh > "${fpath[1]}/_infra"

  # You will need to start a new shell for this setup to take effect.

fish:

  $ infra completion fish | source

  # To load completions for each session, execute once:
  $ infra completion fish > ~/.config/fish/completions/infra.fish

PowerShell:

  PS> infra completion powershell | Out-String | Invoke-Expression

  # To load completions for every new session, run:
  PS> infra completion powershell > infra.ps1
  # and source this file from your PowerShell profile.

Usage:
  infra completion

Global Flags:
      --help               Display help
      --log-level string   Show logs when running the command [error, warn, info, debug] (default "info")

Docs:
image

Related Issues

Resolves #2927

@kimskimchi kimskimchi merged commit 6941288 into main Aug 15, 2022
@kimskimchi kimskimchi deleted the cli-24 branch August 15, 2022 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: incorrect formatting for cli autocomplete
2 participants