cardano-tools: provide command line options and usage in comments

IntersectMBO · Aug 8, 2022 · 56d049d · 56d049d
1 parent a8fbb65
commit 56d049d
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 1 deletion.
diff --git a/ouroboros-consensus-cardano-tools/app/db-analyser.hs b/ouroboros-consensus-cardano-tools/app/db-analyser.hs
@@ -3,6 +3,16 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 
 -- | Database analysis tool.
+--
+-- Usage: db-analyser --db PATH [--verbose]
+--                    [--only-immutable-db [--analyse-from SLOT_NUMBER]]
+--                    [--validate-all-blocks | --minimum-block-validation] COMMAND
+--                    [--show-slot-block-no | --count-tx-outputs |
+--                      --show-block-header-size | --show-block-txs-size |
+--                      --show-ebbs | --store-ledger SLOT_NUMBER | --count-blocks |
+--                      --checkThunks BLOCK_COUNT | --trace-ledger |
+--                      --repro-mempool-and-forge INT]
+--                    [--num-blocks-to-process INT]
 module Main (main) where
 
 import           DBAnalyser.Parsers

diff --git a/ouroboros-consensus-cardano-tools/app/db-synthesizer.hs b/ouroboros-consensus-cardano-tools/app/db-synthesizer.hs
@@ -1,4 +1,25 @@
--- | This tool aims to synthesize a valid ChainDB, replicating cardano-node's UX
+-- | This tool synthesizes a valid ChainDB, replicating cardano-node's UX
+--
+-- Usage: db-synthesizer --config FILE --db PATH
+--                       [--shelley-operational-certificate FILE]
+--                       [--shelley-vrf-key FILE] [--shelley-kes-key FILE]
+--                       [--bulk-credentials-file FILE]
+--                       ((-s|--slots NUMBER) | (-b|--blocks NUMBER) |
+--                         (-e|--epochs NUMBER)) [-f]
+--
+-- Available options:
+--   --config FILE            Path to the node's config.json
+--   --db PATH                Path to the Chain DB
+--   --shelley-operational-certificate FILE
+--                            Path to the delegation certificate
+--   --shelley-vrf-key FILE   Path to the VRF signing key
+--   --shelley-kes-key FILE   Path to the KES signing key
+--   --bulk-credentials-file FILE
+--                            Path to the bulk credentials file
+--   -s,--slots NUMBER        Amount of slots to process
+--   -b,--blocks NUMBER       Amount of blocks to forge
+--   -e,--epochs NUMBER       Amount of epochs to process
+--   -f                       Force overwrite an existing Chain DB
 module Main (main) where
 
 import           System.Exit