Skip to main content

Installation

Officially supported platforms:

  • Linux x86_64
  • Linux arm64
  • macOS Apple Silicon arm64

Intel macOS is currently out of scope.

pip install adaup

System-Wide 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 nodes and related tooling.

Running a Cardano Node

Start a Cardano node for a specific network:

cardano node preview
cardano node mainnet

For a local single-node development network with prepackaged genesis material and an auto-funded default wallet in ~/.cardano/keys, use:

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.

Docker Devnet

For an isolated Conway devnet with working governance, kuber and cardano-db-sync, needing only docker:

cardano devnet up --docker -d --wait   # fresh genesis every run
cardano devnet smoke --docker          # register DReps, submit and vote on every governance action
cardano devnet down --docker

Keys (faucet, pool, committee), configuration and the rendered docker-compose.yml are written to ~/.cardano/devnet-docker. Options, ADAUP_DEVNET_* variables and how to attach other compose projects: Docker Devnet Guide.

Running Cardano CLI Commands

Use the cli subcommand followed by regular cardano-cli arguments:

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

Additional Guides

Binary Sources

  • cardano node and cardano cli use official GitHub release assets from IntersectMBO/cardano-node.
  • cardano mithril uses the official Mithril installer script.
  • cardano hydra resolves binaries in this order:
    1. ADAUP_HYDRA_NODE_PATH and ADAUP_HYDRA_TUI_PATH
    2. Existing hydra-node and hydra-tui in PATH
    3. ADAUP_HYDRA_DOWNLOAD_URL
    4. GitHub Actions artifacts from ADAUP_HYDRA_ACTIONS_RUN_URL

For Hydra Actions artifacts, adaup resolves the artifact from the public GitHub Actions run and downloads it through a public nightly.link URL. The default bundled Hydra version 2.2.0 points to the successful release run 27418396480.

Metadata

Release files for adaup 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adaup 0.4.0
File Size Uploaded
adaup-0.4.0.tar.gz 132.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adaup 0.4.0
File Interpreter ABI Platform
adaup-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 346.0 kB

Release files / adaup-0.4.0.tar.gz

Download URL adaup-0.4.0.tar.gz
Size 132.4 kB
Tags Source
SHA-256 checksum
How to use checksums
bb80200f306da6cfe3c9fd3df906471e08f96e80cf351802e89949144a106d1b
BLAKE2b-256 checksum
How to use checksums
4901b448430da9ea21758fc74a5f1c494d47e41015041d8efc52dcc391f3cecf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.10.21

Release files / adaup-0.4.0-py3-none-any.whl

Download URL adaup-0.4.0-py3-none-any.whl
Size 213.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e69cf08668bc10b8404c779966a711615c9fd6642c9a73ce3ca6bbb4dd698a08
BLAKE2b-256 checksum
How to use checksums
6ada28068ca760b82fecd7f46a668c5d19b3ef47680da336bd1c336d7356ecdf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.10.21

Release history Release notifications | RSS feed

0.5.0

2 release files

This release

0.4.0 This release

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page