mirror of
https://github.com/ihabunek/toot
synced 2025-02-09 08:38:39 +01:00
Add docs for shell completion
This commit is contained in:
parent
bbf67c6736
commit
c7b5669c78
@ -3,6 +3,14 @@ Changelog
|
|||||||
|
|
||||||
<!-- Do not edit. This file is automatically generated from changelog.yaml.-->
|
<!-- Do not edit. This file is automatically generated from changelog.yaml.-->
|
||||||
|
|
||||||
|
**0.40.0 (TBA)**
|
||||||
|
|
||||||
|
* Migrate to `click` for commandline arguments. BC should be mostly preserved,
|
||||||
|
please report any issues.
|
||||||
|
* Add shell completion, see: https://toot.bezdomni.net/shell_completion.html
|
||||||
|
* Remove deprecated `--disable-https` option for `login` and `login_cli`, pass
|
||||||
|
the base URL instead
|
||||||
|
|
||||||
**0.39.0 (2023-11-23)**
|
**0.39.0 (2023-11-23)**
|
||||||
|
|
||||||
* Add `--json` option to many commands, this makes them print the JSON data
|
* Add `--json` option to many commands, this makes them print the JSON data
|
||||||
|
@ -1,8 +1,9 @@
|
|||||||
0.40.0:
|
0.40.0:
|
||||||
date: TBA
|
date: TBA
|
||||||
changes:
|
changes:
|
||||||
- "Migrated to `click` for commandline arguments. BC should be mostly preserved, please report any issues."
|
- "Migrate to `click` for commandline arguments. BC should be mostly preserved, please report any issues."
|
||||||
- "Removed the deprecated `--disable-https` option for `login` and `login_cli`, pass the base URL instead"
|
- "Add shell completion, see: https://toot.bezdomni.net/shell_completion.html"
|
||||||
|
- "Remove deprecated `--disable-https` option for `login` and `login_cli`, pass the base URL instead"
|
||||||
|
|
||||||
0.39.0:
|
0.39.0:
|
||||||
date: 2023-11-23
|
date: 2023-11-23
|
||||||
|
@ -6,6 +6,7 @@
|
|||||||
- [Usage](usage.md)
|
- [Usage](usage.md)
|
||||||
- [Advanced](advanced.md)
|
- [Advanced](advanced.md)
|
||||||
- [Settings](settings.md)
|
- [Settings](settings.md)
|
||||||
|
- [Shell completion](shell_completion.md)
|
||||||
- [TUI](tui.md)
|
- [TUI](tui.md)
|
||||||
- [Contributing](contributing.md)
|
- [Contributing](contributing.md)
|
||||||
- [Documentation](documentation.md)
|
- [Documentation](documentation.md)
|
||||||
|
@ -3,6 +3,14 @@ Changelog
|
|||||||
|
|
||||||
<!-- Do not edit. This file is automatically generated from changelog.yaml.-->
|
<!-- Do not edit. This file is automatically generated from changelog.yaml.-->
|
||||||
|
|
||||||
|
**0.40.0 (TBA)**
|
||||||
|
|
||||||
|
* Migrate to `click` for commandline arguments. BC should be mostly preserved,
|
||||||
|
please report any issues.
|
||||||
|
* Add shell completion, see: https://toot.bezdomni.net/shell_completion.html
|
||||||
|
* Remove deprecated `--disable-https` option for `login` and `login_cli`, pass
|
||||||
|
the base URL instead
|
||||||
|
|
||||||
**0.39.0 (2023-11-23)**
|
**0.39.0 (2023-11-23)**
|
||||||
|
|
||||||
* Add `--json` option to many commands, this makes them print the JSON data
|
* Add `--json` option to many commands, this makes them print the JSON data
|
||||||
|
31
docs/shell_completion.md
Normal file
31
docs/shell_completion.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
# Shell completion
|
||||||
|
|
||||||
|
> Introduced in toot 0.40.0
|
||||||
|
|
||||||
|
Toot uses [Click shell completion](https://click.palletsprojects.com/en/8.1.x/shell-completion/) which works on Bash, Fish and Zsh.
|
||||||
|
|
||||||
|
To enable completion, toot must be [installed](./installation.html) as a command and available by ivoking `toot`. Then follow the instructions for your shell.
|
||||||
|
|
||||||
|
**Bash**
|
||||||
|
|
||||||
|
Add to `~/.bashrc`:
|
||||||
|
|
||||||
|
```
|
||||||
|
eval "$(_TOOT_COMPLETE=bash_source toot)"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Fish**
|
||||||
|
|
||||||
|
Add to `~/.config/fish/completions/toot.fish`:
|
||||||
|
|
||||||
|
```
|
||||||
|
_TOOT_COMPLETE=fish_source toot | source
|
||||||
|
```
|
||||||
|
|
||||||
|
**Zsh**
|
||||||
|
|
||||||
|
Add to `~/.zshrc`:
|
||||||
|
|
||||||
|
```
|
||||||
|
eval "$(_TOOT_COMPLETE=zsh_source toot)"
|
||||||
|
```
|
Loading…
x
Reference in New Issue
Block a user