{"id":29193927,"url":"https://github.com/intersectmbo/cardonnay","last_synced_at":"2025-10-18T04:04:13.996Z","repository":{"id":298449535,"uuid":"993210713","full_name":"IntersectMBO/cardonnay","owner":"IntersectMBO","description":"Cardano local testnets","archived":false,"fork":false,"pushed_at":"2025-06-26T08:48:01.000Z","size":251,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-26T09:41:28.684Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IntersectMBO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-30T12:01:43.000Z","updated_at":"2025-06-26T08:48:04.000Z","dependencies_parsed_at":"2025-06-11T06:57:06.261Z","dependency_job_id":"0269ef8a-0f5d-4061-b773-f2baff3288ad","html_url":"https://github.com/IntersectMBO/cardonnay","commit_stats":null,"previous_names":["intersectmbo/cardonnay"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/IntersectMBO/cardonnay","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardonnay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardonnay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardonnay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardonnay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IntersectMBO","download_url":"https://codeload.github.com/IntersectMBO/cardonnay/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntersectMBO%2Fcardonnay/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263071261,"owners_count":23409255,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-02T03:37:14.789Z","updated_at":"2025-10-18T04:04:08.947Z","avatar_url":"https://github.com/IntersectMBO.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- markdownlint-disable MD033 MD041 --\u003e\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![PyPi Version](https://img.shields.io/pypi/v/cardonnay.svg)](https://pypi.org/project/cardonnay/)\n\n# Cardonnay\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/c0c6b4ef-c647-4e77-952f-1ca9f4beaeec\" alt=\"Cardonnay logo\" width=\"200\"/\u003e\n\u003c/p\u003e\n\n**Cardonnay** is a command-line tool for setting up and managing local Cardano testnets.\u003cbr /\u003e\nIt supports multiple preconfigured testnet types and makes it easy to inspect and control their lifecycle.\n\n---\n\n## 🚀 Getting Started\n\n### 1. Create a `conway_fast` testnet\n\n```sh\n$ cardonnay create -t conway_fast\nStarting the testnet cluster with `/var/tmp/cardonnay/cluster0_conway_fast/start-cluster`:\n[...]\nCluster started 🚀\n```\n\n\u003e ℹ️ **Pro Tip:** Add `-b` to create the testnet in the background, or `-c \"comment\"` to add a comment.\n\n### 2. List running testnet instances\n\n`$ cardonnay control ls`\n\n```json\n[\n  {\n    \"instance\": 0,\n    \"type\": \"conway_fast\",\n    \"state\": \"started\",\n    \"comment\": null\n  }\n]\n```\n\n### 3. Inspect the testnet faucet\n\n`$ cardonnay inspect faucet -i 0`\n\n```json\n{\n  \"address\": \"addr_test1vpgm9cj9u3k63642vju9jqgeqy393upttt0qtwptlesy08gx620qd\",\n  \"vkey_file\": \"/var/tmp/cardonnay/state-cluster0/shelley/genesis-utxo.vkey\",\n  \"skey_file\": \"/var/tmp/cardonnay/state-cluster0/shelley/genesis-utxo.skey\"\n}\n```\n\n### 4. Work with the testnet\n\n```sh\nsource \u003c(cardonnay control print-env -i 0)\ncardano-cli query tip --testnet-magic 42\n```\n\n### 5. Stop all running testnet instances\n\n```sh\n$ cardonnay control stop-all\nStopping the testnet cluster with `/var/tmp/cardonnay/state-cluster0/stop-cluster`:\n[...]\nCluster terminated!\n```\n\n## 🛠️ Installation\n\n### Option 1: Using Nix\n\nIf you use [Nix](https://nixos.org/), you can spin up a development shell with all dependencies:\n\n```sh\nnix develop\n```\n\nThis will provide a fully set-up environment, including Python, Cardano binaries, and `jq`.\n\n\u003e ℹ️ **NOTE:** To use the latest `master` branch of `cardano-node`, run\n\n  ```sh\n  nix flake update --accept-flake-config --override-input cardano-node github:IntersectMBO/cardano-node/master\n  nix develop --accept-flake-config\n  ```\n\n---\n\n### Option 2: Using `pip`\n\nEnsure the following dependencies are installed and available in your `PATH`:\n\n- `python3`\n- `jq`\n- `cardano-node`\n- `cardano-cli`\n- optional: `cardano-submit-api`\n\nThen install **Cardonnay** in a virtual environment:\n\n```sh\n# Create and activate a virtual environment\npython3 -m venv .venv\nsource .venv/bin/activate\n\n# Install Cardonnay\npip install -U --require-virtualenv cardonnay\n\n# (Optional) Enable shell completions for Bash\nsource completions/cardonnay.bash-completion\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersectmbo%2Fcardonnay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintersectmbo%2Fcardonnay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintersectmbo%2Fcardonnay/lists"}