Skip to main content

Managing Localnet

Control your local XYZ Chain with xyz localnet commands.

Start Localnet

Options

Run in Background

Logs are written to ~/.xyz-localnet/node.log.

Fresh Start

Clear existing data and start fresh:

Check Status

Stop Localnet

Options

Stop and Clean

Remove all data when stopping:

View Logs

When running in background:

Lifecycle

Common Workflows

Development Session

Quick Reset

Check Health

Environment Integration

With Scripts

With Make

With Docker Compose

If you prefer Docker:

Troubleshooting

Another process is using required ports:
Check data directory permissions:
Check logs for errors:
Often fixed by resetting:
The node process may be stuck:

Advanced Configuration

Custom Genesis

To customize genesis parameters:

Custom Ports

Edit ~/.xyz-localnet/config/config.toml:
And ~/.xyz-localnet/config/app.toml: