aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-19 19:03:30 +0000
committertv <tv@krebsco.de>2026-11-19 20:14:09 +0100
commit25689b7dc006d5db3e0065d613302c0eb5335efe (patch)
tree7a28d2e1ea98a63643d977c9a2ed041e998ae3dd /docs
parent8a6474557ad9df0b29e7f6fe9f2c231fc9900588 (diff)
share/bash-completion: continuum-party
A hand-written completion, where distributions package it: share/bash-completion/completions/continuum-party, read by bash-completion when first needed (it uses _init_completion and _filedir where they are, plain compgen else). It completes the commands, the intents of `propose` and `fork` (`fork` without `checkpoint`, with `proposal`), the options of each, files where one is taken, `--federation` from ~/.config/continuum/federations (or $XDG_CONFIG_HOME's), and `--revision` and `propose revision` from the features `--version` names. From the node, asked with the options given before the command: the proposals on the current version by hash (`proposals`), for vote, show and fork proposal; the parties (`status`), for remove, give, keys and nodes; and the places holding a value (`values`), for write and values.
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md8
-rw-r--r--docs/guides/federation/getting-started.md6
2 files changed, 13 insertions, 1 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 1b7bd44..56c3347 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -278,3 +278,11 @@ continuum-party vote 8d02 yes # krebs, the only one
[Keys in an ssh-agent](guides/federation/keys.md#keys-in-an-ssh-agent)).
`node` and `token` are secrets: never logged, however they are given.
+
+[`share/bash-completion/completions/continuum-party`](../share/bash-completion/completions/continuum-party)
+completes the client's commands and options in bash: the federations by name, the
+revisions' features, and from the node it works with (the options given before the
+command), the proposals by hash, the parties and the places holding a value. Installed
+where bash-completion looks (`/usr/share/bash-completion/completions/`, or
+`~/.local/share/bash-completion/completions/`), it is read when first needed; else
+`source` it.
diff --git a/docs/guides/federation/getting-started.md b/docs/guides/federation/getting-started.md
index dc0eb25..6a0aec8 100644
--- a/docs/guides/federation/getting-started.md
+++ b/docs/guides/federation/getting-started.md
@@ -13,7 +13,11 @@ cargo build --release --features mycelium,federation
```
That builds the node, `continuum`, and the party's client, `continuum-party`, in
-`target/release/`. Any transport does ([`transports.md`](../../transports.md)).
+`target/release/`. Any transport does ([`transports.md`](../../transports.md)). Bash
+completes the client's commands, proposals and parties with
+`share/bash-completion/completions/continuum-party`
+([`configuration.md`](../../configuration.md),
+[The party's client](../../configuration.md#the-partys-client)).
## A key for each party