Skip to main content
Before you can start building on IOTA, you need to set up your development environment with the necessary tools and dependencies.

Prerequisites

Ensure you have the following installed on your system:
  • Rust (latest stable version)
  • Git
  • pnpm (version 9.6.0 to 9.15.9) for TypeScript SDK development
  • A code editor (VS Code recommended)

Install the IOTA CLI

The IOTA CLI is your primary tool for interacting with the IOTA network and managing Move packages.
1

Install Rust

If you don’t have Rust installed, download it from rust-lang.org:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Follow the on-screen instructions to complete the installation.
2

Clone the IOTA repository

git clone https://github.com/iotaledger/iota.git
cd iota
3

Build and install IOTA CLI

cargo build --release --bin iota
Add the binary to your PATH or install it globally:
cargo install --path crates/iota
4

Verify installation

Check that the IOTA CLI is installed correctly:
iota --version
You should see output with the version number.

Configure IOTA CLI

1

Initialize IOTA client

Set up your IOTA client configuration:
iota client
This command initializes the client and creates a configuration file at ~/.iota/iota_config/client.yaml.
2

Connect to a network

Choose which IOTA network to connect to:
iota client new-env --alias testnet --rpc https://api.testnet.iota.cafe:443
iota client switch --env testnet
3

Create or import an address

Create a new address or import an existing one:
iota client new-address ed25519
Set your active address:
iota client active-address
4

Request test tokens

For testnet or devnet, request tokens from the faucet:
iota client faucet
Check your balance:
iota client gas

Install Move development tools

1

Verify Move compiler

The Move compiler is included with the IOTA CLI. Test it:
iota move --help
2

Install IDE extensions

For VS Code, install the Move language extension:
  • Open VS Code
  • Go to Extensions (Ctrl+Shift+X)
  • Search for “Move”
  • Install the Move language support extension

Set up TypeScript SDK (optional)

If you plan to build frontend applications, install the IOTA TypeScript SDK:
npm install @iota/iota-sdk
For the latest experimental version:
npm install @iota/iota-sdk@experimental

Verify your setup

Confirm everything is working:
# Check IOTA CLI
iota --version

# Check active environment
iota client active-env

# Check active address
iota client active-address

# Check gas balance
iota client gas

Next steps

Now that your environment is set up, you’re ready to:
  • Create your first Move package
  • Write and deploy smart contracts
  • Interact with the IOTA blockchain

Troubleshooting

Rust toolchain issues

If you encounter Rust version issues, check the required version:
cat rust-toolchain.toml
Update your Rust toolchain:
rustup update

Network connection issues

If you cannot connect to a network, verify:
  • Your internet connection is active
  • The RPC endpoint is correct
  • Firewall settings allow outbound connections

CLI not found

If the iota command is not recognized:
  • Ensure the binary is in your PATH
  • Try using the full path to the binary
  • Restart your terminal after installation

Build docs developers (and LLMs) love