Skip to content

TxPark CLI Documentation

Welcome to the TxPark documentation! TxPark provides on-demand ephemeral Tezos X EVM sequencer testnets running on Google Kubernetes Engine (GKE).

What is TxPark?

TxPark is a command-line interface (CLI) tool that simplifies the deployment and management of Tezos X testnets. With simple commands, you can:

  • 🚀 Deploy testnets in minutes
  • 📊 Monitor testnet status and logs
  • 🔄 Upgrade binaries without downtime
  • 🐚 Debug with interactive shell access
  • 🗑️ Clean up with automatic lifetime management

Key Features

On-Demand Testnets

Deploy complete Tezos X environments with a single command. Each testnet includes:

  • EVM Sequencer Node
  • Smart Rollup Node
  • TzKT Indexer
  • Blockscout Explorer
  • Faucet Service
  • Automatic HTTPS with SSL certificates

Flexible Lifetimes

Choose how long your testnet should run:

  • Ephemeral (1h, 4h, 1d) - Automatically deleted after expiration
  • Permanent - Runs until explicitly destroyed

Resource Profiles

Select the right resource allocation for your use case:

  • Default - Standard resources for development and testing
  • High-performance - 2x storage and memory for stress testing

Binary Management

Test different Octez branches easily:

  • Deploy with binaries from any GitLab branch
  • Upgrade running testnets to new binaries
  • Preserve blockchain data across upgrades

Quick Navigation

Quick Start

# Install txpark
curl -sSL https://doc.txpark.nomadic-labs.com/install.sh | bash

# Deploy your first testnet
txpark deploy my-first-testnet --sequencer --build-branch master

# Check status
txpark status my-first-testnet

# View logs
txpark logs my-first-testnet evm-sequencer --follow

# Clean up
txpark destroy my-first-testnet

Need Help?

Ready to get started? Head to the Getting Started Guide →