From 283511b94d63607ef1048166ab9323dbae7537de Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Tue, 24 Mar 2026 00:56:03 +0000 Subject: [PATCH] add ToC to README add Shell Completion section to README --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 8488ff7..00332d9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ # xair-cli +--- + +## Table of Contents + +- [Installation](#installation) +- [Configuration](#configuration) +- [Use](#use) +- [Shell Completion](#shell-completion) +- [License](#license) + ### Installation *xair-cli* @@ -113,6 +123,34 @@ xair-cli snapshot 20 save 'twitch live' --- +## Shell Completion + +- completion: + + *optional* + - args: Shell + - If no shell is passed completion will attempt to detect the current login shell. + +*xair-cli* + +```console +xair-cli completion + +xair-cli completion bash +``` + +*x32-cli* + +```console +x32-cli completion + +x32-cli completion bash +``` + +Currently supported shells: *bash* *zsh* *fish*. + +--- + ### License `xair-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.