Skip to content

Commit 73be9b2

Browse files
Basic documentation for shell completion
Closes #87
1 parent e66eb22 commit 73be9b2

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ and will always work.
3131

3232
## vcf2zarr
3333

34+
3435
Convert a VCF to zarr format:
3536

3637
```
@@ -72,6 +73,21 @@ vcf2zarr encode tmp/sample.exploded tmp/sample.zarr -s sample.schema.json
7273
Use the ``-p, --worker-processes`` argument to control the number of workers used
7374
in the ``explode`` and ``encode`` phases.
7475

76+
### Shell completion
77+
78+
To enable shell completion for a particular session in Bash do:
79+
80+
```
81+
eval "$(_VCF2ZARR_COMPLETE=bash_source vcf2zarr)"
82+
```
83+
84+
If you add this to your ``.bashrc`` vcf2zarr shell completion should available
85+
in all new shell sessions.
86+
87+
See the [Click documentation](https://click.palletsprojects.com/en/8.1.x/shell-completion/#enabling-completion)
88+
for instructions on how to enable completion in other shells.
89+
a
90+
7591
## plink2zarr
7692

7793
Convert a plink ``.bed`` file to zarr format. **This is incomplete**

0 commit comments

Comments
 (0)