> ## Documentation Index
> Fetch the complete documentation index at: https://www.zkcompression.com/llms.txt
> Use this file to discover all available pages before exploring further.
# CLI installation & commands
> Steps to set up your local environment for Light Protocol development. CLI to interact with Light Tokens and compressed accounts on Solana.
Make sure you have a wallet set up at `~/.config/solana/id.json`. [Get one here](https://docs.solanalabs.com/cli/wallets/file-system), if you don't have one.\
The CLI will use this wallet as the default fee payer and mint authority.
# Installation
### Install the CLI
Ensure you have Node >= v20.9.0 installed on your machine. Windows users do not require WSL.
Run this single command to install the CLI.
```bash theme={null}
npm i -g @lightprotocol/zk-compression-cli
```
If you prefer to build the CLI from source, follow the steps below to install the necessary prerequisites.
**1. Activate the Development Environment**
Ensure you are at the root of the monorepo.
```bash theme={null}
. ./scripts/devenv
```
**2. Install and build the monorepo from source. This also builds the CLI.**
```bash theme={null}
./scripts/install.sh
```
```bash theme={null}
./scripts/build.sh
```
**3. Make your CLI available globally**
```bash theme={null}
pnpm link --global
```
```bash theme={null}
# Verify the CLI was correctly installed
which light
```
### Set up your environment
By default, the CLI interacts with localnet. You can view the current config by running:
```bash theme={null}
light config --get
```
**1. Once globally installed, start the Light test validator**
```bash theme={null}
light test-validator
```
This starts a Solana test-validator with the Light System programs and accounts, a prover server, and the Photon indexer as background processes against a clean ledger.
```bash theme={null}
# Pass --skip-indexer to start without the indexer
light test-validator --skip-indexer
# Pass --skip-prover to start without the prover
light test-validator --skip-prover
```
**Note:**
The CLI currently runs the photon indexer and light-prover as background processes at port: `8784` and `3001` respectively.
**2. Ensure you have sufficient localnet funds**
```bash theme={null}
# Airdrop 1 SOL
solana airdrop 1
# Print your address
solana address
# Print your balance
solana balance
```
Now you're all set up to run CLI commands!
To switch to Devnet, point the URLs to an RPC supporting ZK Compression. For example, run:
```bash theme={null}
light config --indexerUrl "https://devnet.helius-rpc.com/?api-key=" \
--proverUrl "https://devnet.helius-rpc.com/?api-key=" \
--solanaRpcUrl "https://devnet.helius-rpc.com/?api-key="
```
Also adjust your solana config:
```bash theme={null}
# Set config
solana config set --url "https://devnet.helius-rpc.com/?api-key="
# Airdrop 1 SOL
solana airdrop 1
# Print your address
solana address
```
# Commands
### Create a Light Token mint
```bash theme={null}
light create-mint
```
```bash theme={null}
USAGE
$ light create-mint [--mint-keypair ] [--mint-authority ]
[--mint-decimals ]
FLAGS
--mint-authority= Path to the mint authority keypair file.
Defaults to the fee payer.
--mint-decimals= Number of base 10 digits to the right
of the decimal place [default: 9].
--mint-keypair= Path to a mint keypair file. Defaults to a
random keypair.
```
### Mint Light Tokens to a Solana wallet
```bash theme={null}
light mint-to --mint "YOUR_MINT_ADDRESS" --to "YOUR_WALLET_ADDRESS" --amount 4200000000
```
```bash theme={null}
USAGE
$ light mint-to --mint --to --amount
[--mint-authority ]
FLAGS
--amount= (required) Amount to mint.
--mint= (required) Mint address.
--mint-authority= File path of the mint authority keypair.
Defaults to local Solana wallet.
--to= (required) Recipient address.
```
### Transfer Light Tokens from one wallet to another
```bash theme={null}
light transfer --mint "YOUR_MINT_ADDRESS" --to "RECIPIENT_WALLET_ADDRESS" --amount 4200000000
```
```bash theme={null}
USAGE
$ light transfer --mint --to --amount
[--fee-payer ]
FLAGS
--amount= (required) Amount to send.
--fee-payer= Fee payer account. Defaults to the client
keypair.
--mint= (required) Mint to transfer
--to= (required) Recipient address
```
### Enable Light Token Interoperability for existing SPL mint
```bash theme={null}
light create-interface-pda --mint "YOUR_MINT_ADDRESS"
```
```bash theme={null}
USAGE
$ light create-interface-pda --mint
FLAGS
--mint= (required) Base58 encoded mint address to register.
```
### Create a Light Token associated token account
```bash theme={null}
light create-token-account "YOUR_MINT_ADDRESS"
```
```bash theme={null}
USAGE
$ light create-token-account MINT [--owner ]
ARGUMENTS
MINT (required) Base58 encoded mint address.
FLAGS
--owner= Owner of the token account. Defaults to the fee
payer's public key.
```
### Wrap SPL tokens into a Light Token account
```bash theme={null}
light wrap-spl --mint "YOUR_MINT_ADDRESS" --to "RECIPIENT_ADDRESS" --amount 1000
```
```bash theme={null}
USAGE
$ light wrap-spl --mint --to --amount
FLAGS
--amount= (required) Amount to wrap, in tokens.
--mint= (required) Mint address.
--to= (required) Recipient address (owner of destination
Light Token account).
```
### Unwrap Light Tokens into an SPL token account
```bash theme={null}
light unwrap-spl --mint "YOUR_MINT_ADDRESS" --to "RECIPIENT_ADDRESS" --amount 1000
```
```bash theme={null}
USAGE
$ light unwrap-spl --mint --to --amount
FLAGS
--amount= (required) Amount to unwrap, in tokens.
--mint= (required) Mint address.
--to= (required) Recipient address (owner of destination
SPL token account).
```
### Check Light Token balance
```bash theme={null}
light token-balance --mint "YOUR_MINT_ADDRESS" --owner "YOUR_WALLET_ADDRESS"
```
```bash theme={null}
USAGE
$ light token-balance --mint --owner
FLAGS
--mint= (required) Mint address of the token account.
--owner= (required) Address of the token owner.
```
### Check wrapped SOL balance
```bash theme={null}
light balance --owner "YOUR_WALLET_ADDRESS"
```
```bash theme={null}
USAGE
$ light balance --owner
FLAGS
--owner= (required) Address of the owner.
```
# Next Steps