You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/command-line-completion.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -12,9 +12,9 @@ By default this command will print on the standard output (the shell window) the
12
12
Use `arduino-cli completion bash > arduino-cli.sh` to generate the completion file.
13
13
At this point you can move that file in `/etc/bash_completion.d/` (root access is required) with `sudo mv arduino-cli.sh /etc/bash_completion.d/`.
14
14
15
-
A not recommended alternative is to source the completion file in `.bashrc`.
15
+
A not recommended alternative is to source the completion file in `~/.bashrc`.
16
16
17
-
Remember to open a new shell to test the functionality
17
+
Remember to open a new shell to test the functionality.
18
18
19
19
### Zsh
20
20
Use `arduino-cli completion zsh > _arduino-cli` to generate the completion file.
@@ -23,23 +23,23 @@ At this point you can place the file in a directory listed in your `fpath` if yo
23
23
Or if you want you can create a directory, add it to your `fpath` and copy the file in it:
24
24
25
25
1.`mkdir ~/completion_zsh`
26
-
2. add `fpath=($HOME/completion_zsh $fpath)` at the beginning of your `.zshrc` file
26
+
2. add `fpath=($HOME/completion_zsh $fpath)` at the beginning of your `~/.zshrc` file
27
27
3.`mv _arduino-cli ~/completion_zsh/`
28
28
29
-
Remember to open a new shell to test the functionality
30
-
31
-
*N.B.*
32
-
The Zsh completion is working with [Oh-My-Zsh](https://ohmyz.sh/) but not with [Prezto](https://github.com/sorin-ionescu/prezto) (the zsh completion system is working in a different way than classic zsh). But hopefully it will be fixed in the future
29
+
Remember to open a new shell to test the functionality.
33
30
34
31
### Fish
35
32
Use `arduino-cli completion fish > arduino-cli.fish` to generate the completion file.
36
33
At this point you can place the file in `~/.config/fish/completions` as stated in the [official documentation](http://fishshell.com/docs/current/index.html#where-to-put-completions).
37
34
Remember to create the directory if it's not already there `mkdir -p ~/.config/fish/completions/` and then place the completion file in there with `mv arduino-cli.fish ~/.config/fish/completions/`
38
35
39
-
Remember to open a new shell to test the functionality
36
+
Remember to open a new shell to test the functionality.
40
37
41
38
#### Disabling command and flag descriptions
42
39
By default fish completion has command and flag description enabled by default. If you want to disable this behaviour you can simply pass the `--no-descriptions` flag when calling `completion` command and the generated file will not have descriptions
43
40
44
41
*N.B.*
45
42
This flag is not compatible with bash or zsh
43
+
44
+
### Brew
45
+
If you install the `arduino-cli` using [homebrew](https://brew.sh/) package manager the completion should work out of the box if you have followed the [official documentation](https://docs.brew.sh/Shell-Completion).
0 commit comments