Skip to content

Commit 4fcde59

Browse files
zanbelkarencfv
authored andcommitted
Add auto completion intruction to docs (#101)
Added more specific instructions how to enable auto completion in the note following the brew install commands. Co-authored-by: Karen Cárcamo <karencfv@users.noreply.github.com>
1 parent f3d653a commit 4fcde59

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

.goreleaser.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,8 @@ brews:
2121
bin.install "ecctl"
2222
system "#{bin}/ecctl", "generate", "completions", "-l", "#{var}/ecctl.auto"
2323
caveats: |
24-
Make sure to source #{var}/ecctl.auto for autocompletions
25-
If you have previously built ecctl from source, make sure you've removed that
26-
binary from any directory that has been added to your user $PATH.
24+
If you have previously built ecctl from source, make sure you've removed that binary from any directory that has been added to your user $PATH.
25+
To enable autocompletion make sure to run `source <(ecctl generate completions)` and add it to your shell interpreter configuration file by running `echo "source <(ecctl generate completions)" >> ~/.bash_profile` or `echo "source <(ecctl generate completions)" >> ~/.zshrc` in case you are using ZSH.
2726
test: system "#{bin}/ecctl version"
2827
folder: Formula
2928
builds:

docs/ecctl-getting-started.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Updating Homebrew...
4646
🍺 /usr/local/Cellar/ecctl/1.0.0: 6 files, 13MB, built in 7 seconds
4747
----
4848

49-
NOTE: To get autocompletions working, they must be sourced from your shell profile.
49+
NOTE: To get autocompletions working make sure to run `source <(ecctl generate completions)`. If you prefer to add to your shell interpreter configuration file run `echo "source <(ecctl generate completions)" >> ~/.bash_profile` or `echo "source <(ecctl generate completions)" >> ~/.zshrc`.
5050

5151
////
5252
[float]

0 commit comments

Comments
 (0)