From e208ee4ed5877c59137c7fb8dea054c3a98a125a Mon Sep 17 00:00:00 2001 From: John Ky Date: Fri, 21 Jul 2023 00:03:28 +1000 Subject: [PATCH] CLI era command groups migration --- docs/CLI-era-command-groups.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/CLI-era-command-groups.md diff --git a/docs/CLI-era-command-groups.md b/docs/CLI-era-command-groups.md new file mode 100644 index 0000000..2217628 --- /dev/null +++ b/docs/CLI-era-command-groups.md @@ -0,0 +1,27 @@ +`cardano-cli` is transitioning to a new command structure where instead of each +era-senstivie command getting an era flag (eg `--babbage-era`, `--conway-era`), +we will have the era as a top-level command. + +For the moment, this will be: + +* `byron`: already exists and will be unchanged +* `shelley`: re-purposed to mean `shelley-era` only rather than `shelley-based` era +* `allegra`: `allegra` era only +* `mary`: `mary` era only +* `alonzo`: `alonzo` era only +* `babbage`: `babbage` era only +* `conway`: `conway` era only + +Then we will have the following: + +* `latest`: the latest supported era. The latest officially supported era in the CLI +* `experimental`: the era following the latest era that is not yet officially supported in the CLI +* `legacy`: the commands that existed before the restructuring. Gradually these commands + will be migrated to fit into the new command structure. + +The `latest` command group is implied, so any sub-commands there-in will also be available +at the top-level for convenience. + +The `legacy` command group is also implied, so any sub-commands there-in will be +available at the top-level for convenience provided that the `latest` version of that +command does not yet exist.