How do I install Nigiri on Windows?

Use WSL with the curl install script, as native Windows support is limited; ensure Docker is configured for WSL integration, and prepend commands with 'wsl' if needed, per the README notes.

Nigiri vs Polar: which is better for Lightning development?

Nigiri offers a more extensible stack with Liquid and Ark layers via CLI flags, while Polar is focused on Lightning Network with a GUI; choose Nigiri for multi-layer testing or Polar for pure Lightning simplicity.

How to customize Bitcoin.conf in Nigiri?

Edit the config files in the data directory (e.g., ~/.nigiri on POSIX), as mentioned in the README, but note that advanced changes may require modifying docker-compose.yml directly.

Can Nigiri be used with testnet or mainnet?

No, Nigiri is designed only for regtest environments; for testnet or mainnet development, you'd need to manually configure services outside of Nigiri's pre-built setup.

How to fix port 5000 errors on Mac?

Disable AirPlay Receiver in System Preferences or change Esplora's port in docker-compose.yml in the data directory, then run 'nigiri stop --delete' before restarting, as detailed in the README troubleshooting.

What are the alternatives to Nigiri for Bitcoin regtest?

Options include manual Bitcoin Core setups, tools like Bitcoin in a Box for Docker, or Polar for Lightning-focused environments; Nigiri stands out for its CLI-driven extensibility with Liquid and Ark.

Nigiri — Bitcoin Regtest Docker CLI Tool

What is Nigiri?

Nigiri is a Docker-based command-line tool that sets up a complete Bitcoin regtest development environment. It provides a Bitcoin Core node, Electrum server, block explorer, and extensible options for Liquid, Lightning Network, and Ark layers, allowing developers to test and build Bitcoin applications locally without configuring each component manually.

Target Audience

Bitcoin and blockchain developers who need a local, reproducible regtest environment for building and testing applications, smart contracts, or layer-two solutions.

Value Proposition

Developers choose Nigiri because it offers a pre-configured, extensible stack with a simple CLI, eliminating the hassle of setting up individual Bitcoin services and enabling rapid iteration with features like automated block generation and faucet endpoints.

🍣 A delicious docker box for special Bitcoin cookings

Use Cases

Best For

Testing Bitcoin transaction flows in a controlled regtest environment
Developing and experimenting with Liquid sidechain assets and contracts
Building Lightning Network applications with Core Lightning and LND nodes
Prototyping Ark layer-two solutions for scalable off-chain transactions
Learning Bitcoin development with a ready-to-use local setup
Automating blockchain tests with CLI-controlled block generation and faucet

Not Ideal For

Production or testnet deployments requiring real blockchain synchronization
Environments where Docker and containerization are not available or preferred
Projects needing deep, low-level customization of Bitcoin node beyond provided config files
Teams with strict Windows native setups without WSL compatibility

Pros & Cons

Pros

Batteries-Included Regtest

Out-of-the-box setup includes Bitcoin Core, Electrum backend, and Esplora frontend for blockchain inspection at localhost:5000, eliminating manual configuration hassles.

Seamless Extensibility

Simple CLI flags like --liquid, --ln, and --ark add Liquid sidechain, Lightning nodes (Core Lightning, LND), and Ark layer-two, enabling rapid prototyping of multi-layer solutions.

Developer Productivity Features

Chopsticks proxy provides automated block generation and faucet endpoints (e.g., POST /faucet), streamlining testing workflows as shown in the faucet and push commands.

Unified CLI Management

Single interface for starting/stopping services, funding addresses, accessing node CLIs, and checking logs, reducing command complexity and learning curve.

Cons

Docker Dependency Overhead

Heavily relies on Docker Compose, making it unsuitable for lightweight or restricted environments, as noted in the Windows WSL requirement and Docker daemon management.

Platform-Specific Conflicts

On macOS, port 5000 conflicts with AirPlay Receiver require manual fixes like disabling AirPlay or editing docker-compose.yml, adding unexpected setup complexity.

Regtest-Only Limitation

Designed exclusively for local regtest, so it cannot be used for development testing on testnet or mainnet without significant external modifications.

What is Nigiri?

Target Audience

Bitcoin and blockchain developers who need a local, reproducible regtest environment for building and testing applications, smart contracts, or layer-two solutions.

Value Proposition

Use Cases

Best For

Testing Bitcoin transaction flows in a controlled regtest environment
Developing and experimenting with Liquid sidechain assets and contracts
Building Lightning Network applications with Core Lightning and LND nodes
Prototyping Ark layer-two solutions for scalable off-chain transactions
Learning Bitcoin development with a ready-to-use local setup
Automating blockchain tests with CLI-controlled block generation and faucet

Not Ideal For

Production or testnet deployments requiring real blockchain synchronization
Environments where Docker and containerization are not available or preferred
Projects needing deep, low-level customization of Bitcoin node beyond provided config files
Teams with strict Windows native setups without WSL compatibility

Pros & Cons

Pros

Batteries-Included Regtest

Out-of-the-box setup includes Bitcoin Core, Electrum backend, and Esplora frontend for blockchain inspection at localhost:5000, eliminating manual configuration hassles.

Seamless Extensibility

Simple CLI flags like --liquid, --ln, and --ark add Liquid sidechain, Lightning nodes (Core Lightning, LND), and Ark layer-two, enabling rapid prototyping of multi-layer solutions.

Developer Productivity Features

Chopsticks proxy provides automated block generation and faucet endpoints (e.g., POST /faucet), streamlining testing workflows as shown in the faucet and push commands.

Unified CLI Management

Single interface for starting/stopping services, funding addresses, accessing node CLIs, and checking logs, reducing command complexity and learning curve.

Cons

Docker Dependency Overhead

Heavily relies on Docker Compose, making it unsuitable for lightweight or restricted environments, as noted in the Windows WSL requirement and Docker daemon management.

Platform-Specific Conflicts

On macOS, port 5000 conflicts with AirPlay Receiver require manual fixes like disabling AirPlay or editing docker-compose.yml, adding unexpected setup complexity.

Regtest-Only Limitation

Designed exclusively for local regtest, so it cannot be used for development testing on testnet or mainnet without significant external modifications.

Nigiri

What is Nigiri?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Nigiri

What is Nigiri?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?