https://github.com/intersectmbo/cardonnay
Cardano local testnets
https://github.com/intersectmbo/cardonnay
Last synced: 5 months ago
JSON representation
Cardano local testnets
- Host: GitHub
- URL: https://github.com/intersectmbo/cardonnay
- Owner: IntersectMBO
- License: apache-2.0
- Created: 2025-05-30T12:01:43.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2025-06-26T08:48:01.000Z (9 months ago)
- Last Synced: 2025-06-26T09:41:28.684Z (9 months ago)
- Language: Shell
- Size: 245 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/astral-sh/ruff)
[](https://pypi.org/project/cardonnay/)
# Cardonnay
**Cardonnay** is a command-line tool for setting up and managing local Cardano testnets.
It supports multiple preconfigured testnet types and makes it easy to inspect and control their lifecycle.
---
## đ Getting Started
### 1. Create a `conway_fast` testnet
```sh
$ cardonnay create -t conway_fast
Starting the testnet cluster with `/var/tmp/cardonnay/cluster0_conway_fast/start-cluster`:
[...]
Cluster started đ
```
> âšī¸ **Pro Tip:** Add `-b` to create the testnet in the background, or `-c "comment"` to add a comment.
### 2. List running testnet instances
`$ cardonnay control ls`
```json
[
{
"instance": 0,
"type": "conway_fast",
"state": "started",
"comment": null
}
]
```
### 3. Inspect the testnet faucet
`$ cardonnay inspect faucet -i 0`
```json
{
"address": "addr_test1vpgm9cj9u3k63642vju9jqgeqy393upttt0qtwptlesy08gx620qd",
"vkey_file": "/var/tmp/cardonnay/state-cluster0/shelley/genesis-utxo.vkey",
"skey_file": "/var/tmp/cardonnay/state-cluster0/shelley/genesis-utxo.skey"
}
```
### 4. Work with the testnet
```sh
source <(cardonnay control print-env -i 0)
cardano-cli query tip --testnet-magic 42
```
### 5. Stop all running testnet instances
```sh
$ cardonnay control stop-all
Stopping the testnet cluster with `/var/tmp/cardonnay/state-cluster0/stop-cluster`:
[...]
Cluster terminated!
```
## đ ī¸ Installation
### Option 1: Using Nix
If you use [Nix](https://nixos.org/), you can spin up a development shell with all dependencies:
```sh
nix develop
```
This will provide a fully set-up environment, including Python, Cardano binaries, and `jq`.
> âšī¸ **NOTE:** To use the latest `master` branch of `cardano-node`, run
```sh
nix flake update --accept-flake-config --override-input cardano-node github:IntersectMBO/cardano-node/master
nix develop --accept-flake-config
```
---
### Option 2: Using `pip`
Ensure the following dependencies are installed and available in your `PATH`:
- `python3`
- `jq`
- `cardano-node`
- `cardano-cli`
- optional: `cardano-submit-api`
Then install **Cardonnay** in a virtual environment:
```sh
# Create and activate a virtual environment
python3 -m venv .venv
source .venv/bin/activate
# Install Cardonnay
pip install -U --require-virtualenv cardonnay
# (Optional) Enable shell completions for Bash
source completions/cardonnay.bash-completion
```