aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
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