Skip to content

Commit e92d280

Browse files
committed
Add completion instructions to readme
1 parent f31b86d commit e92d280

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
build/
22
dist/
3+
github-access-token

readme.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,61 @@ flit login
3434
and enter a [DigitalOcean personal access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/) and a [Tailscale auth key](https://tailscale.com/kb/1085/auth-keys) and you're ready to go!
3535

3636

37+
## Completions
38+
39+
To load completions:
40+
41+
### Bash
42+
43+
```bash
44+
source < (flit completion bash)
45+
```
46+
47+
To load completions for each session, execute once:
48+
49+
```bash
50+
# Linux
51+
flit completion bash > /etc/bash_completion.d/flit-vpn
52+
53+
# macOS
54+
flit completion bash > $(brew --prefix)/etc/bash_completion.d/flit-vpn
55+
```
56+
57+
### Zsh
58+
59+
To load completions for each session, execute once:
60+
61+
```bash
62+
flit completion zsh > "${fpath[1]}/_%[1]s"
63+
```
64+
65+
### Fish
66+
67+
```fish
68+
flit completion fish | source
69+
```
70+
71+
To load completions for each session, execute once:
72+
73+
```fish
74+
flit completion fish > ~/.config/fish/completions/flit-vpn.fish
75+
```
76+
77+
### PowerShell
78+
79+
```powershell
80+
PS> flit completion powershell | Out-String | Invoke-Expression
81+
```
82+
83+
To load completions for every new session, run:
84+
85+
```
86+
PS> flit completion powershell > flit-vpn.ps1
87+
```
88+
89+
and source this file from your PowerShell profile.
90+
91+
3792
## Possible Future Features
3893

3994
- Other cloud providers for node deployment

0 commit comments

Comments
 (0)