Quick Start Guide
Chia is a cryptocurrency and blockchain with smart transaction capabilities. Its PoST consensus is the first (and only) Nakamoto consensus since Proof of Work, and has a much lower energy consumption.
Chia's mainnet was launched on March 19, 2021. Development of its ecosystem is ongoing, with primitives recently launched for CATs, Offers, NFTs and DIDs.
The Chia software is easy to install. You can start earning cryptocurrency rewards by storing plot files on your hard drive and leaving the machine running.
Install Chia
The easiest way to install Chia is to use an installer. However, you can install from source if you want some extra control over the client.
For more detailed steps you can follow these install instructions according to your operating system. This software only supports 64 bit operating systems.
Binaries
- Installer
- APT
- YUM
- DNF
- Windows
- macOS Apple Silicon
- macOS Intel [Catalina 10.15 and later]
- macOS Intel [Mojave 10.14]
- Ubuntu/Debian
- Ubuntu/Debian ARM
- CentOS/Redhat
For convenience, direct links are provided to the latest installer builds. However, you should always visit https://www.chia.net/download/ to verify the checksum of the download.
# Install packages
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg
# Add GPG key
curl -sL https://repo.chia.net/FD39E6D3.pubkey.asc | sudo gpg --dearmor -o /usr/share/keyrings/chia.gpg
# Set up repository
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/chia.gpg] https://repo.chia.net/debian/ stable main" | sudo tee /etc/apt/sources.list.d/chia.list > /dev/null
sudo apt-get update
# Install chia-blockchain
sudo apt-get install chia-blockchain
# Use chia-blockchain-cli instead for CLI only
# Install packages
sudo yum install -y yum-utils
sudo yum-config-manager --add-repo https://repo.chia.net/rhel/chia-blockchain.repo
# Install chia-blockchain
sudo yum install chia-blockchain
# Use chia-blockchain-cli for CLI only
# Install packages
sudo dnf install 'dnf-command(config-manager)'
sudo dnf config-manager --add-repo https://repo.chia.net/rhel/chia-blockchain.repo
# Install chia-blockchain
sudo dnf install chia-blockchain
# Use chia-blockchain-cli for CLI only
Source
- Linux/MacOS Source
- Windows Source
- Developer Builds
Make sure you have Python 3.9 installed.
# Download chia-blockchain
git clone https://github.com/Chia-Network/chia-blockchain
# Install dependencies
sh install.sh
# Create virtual environment
python3 -m venv venv
# Activate virtual environment
. ./venv/bin/activate
# Initialize
chia init
Make sure you have Python 3.9 and Git installed.
# Download chia-blockchain
git clone https://github.com/Chia-Network/chia-blockchain
# Install dependencies
./Install.ps1
# Create virtual environment
py -m venv venv
# Activate virtual environment
. ./venv/Scripts/Activate.ps1
# Initialize
chia init
- Windows Dev build
- macOS Apple Silicon Dev build
- macOS Intel Dev build [Catalina 10.15 and later]
- Ubuntu/Debian Dev build
- Ubuntu/Debian ARM Dev build
- CentOS/Redhat Dev build
For convenience, direct links are provided to the latest installer builds. However, you should always visit https://www.chia.net/download/ to verify the checksum of the download.
All configuration data is stored in a directory structure at the $CHIA_ROOT
environment variable or at ~/.chia/mainnet/
. You can find databases, and logs there. Optionally, you can set $CHIA_ROOT
to the .chia
directory in your home directory with export CHIA_ROOT=~/.chia
and if you add it to your .bashrc
or .zshrc
it will remain set across logouts and reboots. If you set $CHIA_ROOT
you will have to migrate configuration items by hand or unset the variable for chia init
to work with unset CHIA_ROOT
.
If you are using the MacOS or Windows builds, your keys are created during the first run. We recommend writing down the mnemonic (24 ordered words).
CLI Setup
Using the CLI with Chia gives you greater and more precise control. For a more details on the commands, read the CLI Commands Reference.
- MacOS / Linux
- Windows
- Linux
There are commands available in /Applications/Chia.app/Contents/Resources/app.asar.unpacked/daemon
.
Try ./chia -h
or ./chia plots -h
for example. You can view your debug.log as it runs in from the terminal with tail -f ~/.chia/mainnet/log/debug.log
. Additionally, you can open the file with Console application.
A handy trick is to add that directory to your path - export PATH=/Applications/Chia.app/Contents/Resources/app.asar.unpacked/daemon:$PATH
. To make it persistent add the same line to your .bashrc
or .zshrc
inside of your user directory.
You can learn how to use the Graphical User Interface (GUI) in the Using the GUI page.
You can start with the Command Line Interface (CLI) by checking the commands available in ~\AppData\Local\Chia-Blockchain\app-1.1.5\resources\app.asar.unpacked\daemon\
. Try .\chia -h
or .\chia plots -h
for example:
Open PowerShell
On start menu type "powershell" and press the enter key.
Change Directory with
cd
On PowerShell type
cd $env:localAPPDATA\Chia-Blockchain\app-1.1.5\resources\app.asar.unpacked\daemon\
and press the enter key.Read Chia help
On PowerShell type
.\chia -h
and press the enter key.
For more information you can read the CLI Commands Reference page.
You can view your logs by opening \.chia\mainnet\log\debug.log
with a text editor like Visual Studio Code or see it as it runs in PowerShell by using Get-Content, Get-Content ~\.chia\mainnet\log\debug.log -wait
.
If you installed Chia with the Linux installer files, your Chia executable should be in one of the following locations:
/usr/lib/chia-blockchain/resources/app.asar.unpacked/daemon/chia
/lib/chia-blockchain/resources/app.asar.unpacked/daemon/chia
If you installed from source (using git), just activate and run chia
directly.
Migrate or set up configuration files
chia init
Generate keys
Create some keys by running the following script if you don't already have keys:
chia keys generate
Run a full node + farmer + harvester + wallet
To run a full node on port 8444, and connect to the mainnet, run the following command. Logs are usually at ~/.chia/mainnet/logs/debug.log
or ~\.chia\mainnet\logs\debug.log
on Windows
Headless:
chia start farmer
GUI:
sh install-gui.sh
cd chia-blockchain-gui
npm run electron &
Farmers are entities in the network who use their drive space to try to create blocks (like Bitcoin's miners), and earn block rewards.
Plotting
Plotting is the process of creating plots to be farmed. Once a plot is created, it can be farmed indefinately. In other words, you do not have to plot forever, just plot until you are out of storage.
Reference our plotting guide for more details.
You can use the command line tools and change the working directories and output directory for plotting, with the -t
(temp), -2
(second temp), and -d
(destination) arguments to the chia plots create
command. -n 2
will create two plots of type k=32.
chia plots create -k 32 -n 2
chia plots check -n 30
Tips
Ubuntu 20.04 LTS or newer, Amazon Linux 2, and CentOS 7.7 or newer are the easiest linux install environments.
UPnP is enabled by default to open port 8444 for incoming connections.
If this causes issues, you can disable it in config.yaml
. Or you can run this command: chia configure -upnp false
Some routers may require port forwarding, or enabling UPnP
in the router's configuration.
RPC Interface
The Node has an RPC interface. This RPC will allow you to interact with the Chia node through code.