clubs-cli 0.1.0

Command-line interface for composing and inspecting Gordian Club editions.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# `clubs-cli` (`clubs`)

`clubs-cli` is a command-line interface for working with Blockchain Commons' Gordian Clubs. It orchestrates the underlying [`clubs`](https://crates.io/crates/clubs) crate to compose editions, attach permits, verify signatures, check provenance continuity, and demonstrate decryption paths.ubs-cli` (`clubs`)

`clubs-cli` is a command-line interface for working with Blockchain Commons’ Gordian Clubs. It orchestrates the underlying [`clubs`](../clubs) crate to compose editions, attach permits, verify signatures, check provenance continuity, and demonstrate decryption paths.

> **Status:** the tool is not published on crates.io. Build it from the git workspace. The crate expects the `clubs` library source to be available via a sibling path because Cargo manifests currently reference `../clubs` directly.

## Usage overview

The CLI currently focuses on single-publisher workflows and provides the following subcommands:

- `clubs init` – convenience wrapper for producing the first edition of a club.
- `clubs edition compose` – general-purpose edition composer for subsequent releases.
- `clubs edition verify` – signature and provenance checks for a single edition.
- `clubs edition permits` – extract sealed member permits from an edition.
- `clubs edition sequence` – prove that a set of editions belong to the same club and form a contiguous provenance chain.
- `clubs content decrypt` – recover plaintext content using a permit, SSKR shards, or symmetric key.

Run `clubs --help` or `clubs <command> --help` for full flag listings.

## Installation

Install via cargo:

```bash
cargo install clubs-cli
```

The installed binary is named `clubs`.

## Getting started

Run `clubs --help` to see available commands. Start by examining the `demo-log.md` file in the [source repository](https://github.com/BlockchainCommons/bc-rust/tree/master/clubs-cli), which is produced by the demo script and illustrates a complete end-to-end scenario.

## Demonstration script

The `clubs-cli/clubs-demo.py` script drives the installed CLI together with the other Gordian tools (notably `envelope` and `provenance`). It produces a Markdown transcript (`demo-log.md`) that documents a reproducible end-to-end scenario:

- Generate publisher and member key material.
- Author initial club content, compute its digest, and bind it to a genesis provenance mark.
- Compose and verify the genesis edition with both permit styles.
- Advance the provenance chain, compose a subsequent edition, and validate the continuity using `clubs edition sequence`.

Running the script requires the `provenance` and `envelope` tools to be on `PATH`:

```bash
cd clubs-cli
./clubs-demo.py > demo-log.md
```

## Version history

- **0.1.0** (October 1, 2025) – Initial release with subcommands for edition composition, verification, provenance sequencing, permit extraction, and content decryption.