diff --git a/README.md b/README.md index 61eb54b6d4..000368addc 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,19 @@ The `cardano-cli` tool allows users to perform various operations and actions on ## Executables -You can download the hydra binaries of ``cardano-node`` and ``cardano-cli`` from the [release notes](https://github.com/IntersectMBO/cardano-node/releases) +You can download the binaries of `cardano-cli` compatible with specific versions of `cardano-node` from [cardano-node's release notes](https://github.com/IntersectMBO/cardano-node/releases). + +You can also download binaries of all versions of `cardano-cli` from [cardano-cli's release notes](https://github.com/IntersectMBO/cardano-cli/releases) + +## Documentation + +Up to date command line help reference is available here: +* [List of all commands](cardano-cli/test/cardano-cli-golden/files/golden/help.cli) +* [Description of each command's options](cardano-cli/test/cardano-cli-golden/files/golden/help) + +Development documentation can be found in [Cardano Node Wiki](https://github.com/input-output-hk/cardano-node-wiki/wiki). + +Haddock documentation is available at: https://cardano-cli.cardano.intersectmbo.org/ ## Contributing @@ -28,12 +40,6 @@ See the [Contributing guide](CONTRIBUTING.md) for how to contribute to this proj * [Clément Hurlin](https://github.com/smelc) * [Pablo Lamela](https://github.com/palas) -## Documentation - -Development documentation can be found in [Cardano Node Wiki](https://github.com/input-output-hk/cardano-node-wiki/wiki). - -Haddock documentation is available at: https://cardano-cli.cardano.intersectmbo.org/ - [![x86\_64-linux](https://img.shields.io/endpoint?url=https://ci.iog.io/job/IntersectMBO-cardano-cli/main/x86_64-linux.required/shield&style=flat-square&label=x86_64-linux)](https://ci.iog.io/job/IntersectMBO-cardano-cli/main/x86_64-linux.required) [![x86\_64-darwin](https://img.shields.io/endpoint?url=https://ci.iog.io/job/IntersectMBO-cardano-cli/main/x86_64-darwin.required/shield&style=flat-square&label=x86_64-darwin)](https://ci.iog.io/job/IntersectMBO-cardano-cli/main/x86_64-darwin.required) diff --git a/cardano-cli/README.md b/cardano-cli/README.md index 0be7d765b9..3d46a6b621 100644 --- a/cardano-cli/README.md +++ b/cardano-cli/README.md @@ -1,81 +1,4 @@ # cardano-cli - A CLI utility to support a variety of key material operations (genesis, migration, pretty-printing..) for different system generations. -The general synopsis is as follows: - -``` - Usage: cardano-cli (Genesis related CMDs | Key related CMDs | Delegation related CMDs | Transaction related CMDs | Local node related CMDs) -``` - -The top-level commands are as shown below. - -```bash -$ cardano-cli --help -cardano-cli - utility to support a variety of key operations (genesis -generation, migration, pretty-printing..) for different system generations. - -Usage: cardano-cli (Era based commands | Byron specific commands | - Miscellaneous commands) - -Available options: - --version Show the cardano-cli version - -h,--help Show this help text - -Era based commands - address Payment address commands - stake-address Stake address commands - key Key utility commands - transaction Transaction commands - node Node operation commands - stake-pool Stake pool commands - query Node query commands. Will query the local node whose - Unix domain socket is obtained from the - CARDANO_NODE_SOCKET_PATH environment variable. - genesis Genesis block commands - governance Governance commands - text-view Commands for dealing with Shelley TextView files. - Transactions, addresses etc are stored on disk as - TextView files. - -Byron specific commands - byron Byron specific commands - -Miscellaneous commands - version Show the cardano-cli version -``` - -Byron-specific commands - -```bash -$ cardano-cli byron --help -Usage: cardano-cli byron (key | transaction | query | genesis | governance | - miscellaneous) - Byron specific commands - -Available options: - -h,--help Show this help text - -Available commands: - key Byron key utility commands - transaction Byron transaction commands - query Byron node query commands. - genesis Byron genesis block commands - governance Byron governance commands - miscellaneous Byron miscellaneous commands -``` - -## How to build - -### Cabal - -Use [Cabal - Version 3.6.2.0](https://www.haskell.org/cabal/) to build and/or install this project: - -``` -$ cd cardano-cli -$ cabal build -$ cabal install -``` - -It may be necessary to specify the installation directory when installing the command using the `--installdir` option.