docs: add CLI usage and integrate generation in release
This commit is contained in:
50
www/docs/cli/filebrowser-completion-bash.md
Normal file
50
www/docs/cli/filebrowser-completion-bash.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# filebrowser completion bash
|
||||
|
||||
Generate the autocompletion script for bash
|
||||
|
||||
## Synopsis
|
||||
|
||||
Generate the autocompletion script for the bash shell.
|
||||
|
||||
This script depends on the 'bash-completion' package.
|
||||
If it is not installed already, you can install it via your OS's package manager.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
source <(filebrowser completion bash)
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
### Linux:
|
||||
|
||||
filebrowser completion bash > /etc/bash_completion.d/filebrowser
|
||||
|
||||
### macOS:
|
||||
|
||||
filebrowser completion bash > $(brew --prefix)/etc/bash_completion.d/filebrowser
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
```
|
||||
filebrowser completion bash
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for bash
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
-c, --config string config file path
|
||||
-d, --database string database path (default "./filebrowser.db")
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
* [filebrowser completion](filebrowser-completion.md) - Generate the autocompletion script for the specified shell
|
||||
|
||||
Reference in New Issue
Block a user