mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2025-01-18 10:07:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

docs: describe how to set up completion for each shell

Browse source 
Setting up completion is particularly non-obvious for Zsh, so let's
provide the exact command(s) for each supported shell.

Closes #67.
This commit is contained in:
Martin von Zweigbergk 2022-02-27 13:53:41 -08:00 committed by Martin von Zweigbergk
parent 70811669fc
commit e11e373427
1 changed files with 25 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -138,12 +138,6 @@ Now run this (regardless of platform):
cargo install --git https://github.com/martinvonz/jj.git cargo install --git https://github.com/martinvonz/jj.git
``` ```
To set up command-line completion, source the output of
`jj debug completion --bash/--zsh/--fish`. For example, if you use Bash:
```shell script
source <(jj debug completion) # --bash is the default
```
You may also want to configure your name and email so commits are made in your You may also want to configure your name and email so commits are made in your
name. Create a file at `<config dir>/jj/config.toml` (where `<config dir>` is name. Create a file at `<config dir>/jj/config.toml` (where `<config dir>` is
`${XDG_CONFIG_HOME}` or `~/.config/` on Linux, `~/Library/Application Support/` `${XDG_CONFIG_HOME}` or `~/.config/` on Linux, `~/Library/Application Support/`
@ -156,6 +150,31 @@ name = "Martin von Zweigbergk"
email = "martinvonz@google.com" email = "martinvonz@google.com"
``` ```
### Command-line completion
To set up command-line completion, source the output of
`jj debug completion --bash/--zsh/--fish`. Exactly how to source it depends on
your shell.
#### Bash
```shell script
source <(jj debug completion) # --bash is the default
```
#### Zsh
```shell script
autoload -U compinit
compinit
source <(jj debug completion --zsh | sed '$d') # remove the last line
compdef _jj jj
```
#### Fish
```shell script
jj debug completion --fish | source
```
### Nix OS ### Nix OS
If you're on Nix OS you can use the flake for this repository. If you're on Nix OS you can use the flake for this repository.