https://github.com/cardanoapi/adaup
Automatically download cardano services and use them in cli
https://github.com/cardanoapi/adaup
Last synced: 19 days ago
JSON representation
Automatically download cardano services and use them in cli
- Host: GitHub
- URL: https://github.com/cardanoapi/adaup
- Owner: cardanoapi
- Created: 2025-08-04T04:13:16.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2026-05-21T08:10:37.000Z (28 days ago)
- Last Synced: 2026-05-21T15:40:37.747Z (27 days ago)
- Language: Python
- Size: 69.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## Installation
**⚠️ Warning:** Only **x86/64 Linux** platform is supported.
```bash
pip install adaup
```
#### SystemWide Installation
```
sudo pip install --upgrade adaup --break-system-packages
```
After installation, the `cardano` executable will be available in your PATH.
## Usage
The `cardano` executable provides a command-line interface to manage Cardano and Hydra nodes.
### Running a Cardano Node
To start a Cardano node for a specific network (e.g., `preview` or `preprod` or `mainnet` ), use the `node` command:
```bash
cardano node preview
```
You can also specify a different network or node version:
```bash
cardano node mainnet
```
For a local single-node development network with prepackaged genesis material and an auto-funded default wallet in `~/.cardano/keys`, use:
```bash
cardano node devnet
```
This starts a local node at `~/.cardano/devnet/node.socket` using cardano-node `11.0.1`, regenerates `payment.*`, `stake.*` and `payment.addr` under `~/.cardano/keys` on each run, and funds that address with `1000000000000` lovelace (1,000,000 ADA) from the devnet faucet. The packaged devnet genesis funds the faucet with enough lovelace for repeated local bootstraps.
### Running Cardano CLI Commands
To execute `cardano-cli` commands, use the `cli` subcommand followed by the `cardano-cli` arguments:
```bash
export CARDANO_NODE_SOCKET_PATH=~/.cardano/preview/node.socket
cardano cli query tip --testnet-magic 2
cardano cli query tip --testnet-magic=2 --socket-path=~/.cardano/preview/node.socket ## socket path in the cli
```
### Running a Hydra Cluster
To set up and run a Hydra cluster:
1. **Bootstrap Hydra Node Credentials:**
Generate the necessary folders and credentials for your Hydra nodes. This will create `hydra-{n}` directories under `$HOME/.cardano//`.
**e.g.** this will generate configuration for running 2 hydra nodes.
```bash
cardano hydra bootstrap preview 2
```
2. **Start 1st Hydra Node:**
```bash
cardano hydra node preview 0
```
2. **Start 2nd Hydra Node in different terminal:**
```bash
cardano hydra node preview 1
```
**Note** the command to run this node is available at `~/.cardano/preview/hydra-0/run.sh`
3. **Watch hydra status in Hydra TUI :**
To interact with a running Hydra node, you can open the Text User Interface (TUI):
```bash
cardano hydra tui 0
```
4. **Reset Hydra Head Data :**
Shutdown you nodes, and use `reset` command to restart a new hydra head with same configurations. You can then start the nodes again.
```bash
cardano hydra reset preview
```
5. **Prune Hydra Cluster :**
To remove all keys, data and cluster information. You need to `bootstrap` the cluster again.
```bash
cardano hydra prune preview
```