Skip to content

Commit a3b2d38

Browse files
committed
add completions readme
1 parent 2f17228 commit a3b2d38

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

support/completions/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Completions for bashly executable
2+
3+
This directory contains support file for generating bash completions.
4+
5+
## For developers
6+
7+
From the root directory of the repository, run `run completions`. This will:
8+
9+
1. Read the `completely.yaml.gtx` template
10+
2. Write the `completely.yaml` file
11+
3. Generate the `bashly-completions.bash` file
12+
4. Copy it to the completions directory with `sudo`
13+
14+
## For users
15+
16+
Install completions in one of two ways:
17+
18+
1. Run `bashly completions --install`. This will make a best effort to copy
19+
the completions script to your completions directory.
20+
2. If the above fails, run `bashly completions > out.bash`, then copy the file
21+
manually to your completions directory (or simply get the
22+
`bashly-completions.bash` from this directory).

0 commit comments

Comments
 (0)