Skip to content

tari-project/tari-cli

Repository files navigation

🚀 Tari CLI

The complete toolkit for developing Tari smart contracts

GitHub Release CI Build Status

The Tari CLI transforms smart contract development on the Tari Layer-2 blockchain into a delightful experience. From project scaffolding to deployment, every step is designed for developer productivity and confidence.

✨ What You Can Build

  • NFT Collections: Create unique digital assets with custom metadata
  • Token Systems: Build fungible tokens with advanced features
  • DeFi Protocols: Develop decentralized finance applications
  • Custom Templates: Design reusable smart contract patterns

🚀 Quick Start

Get your first Tari smart contract deployed in under 5 minutes:

1. Install Tari CLI

# Using Cargo
cargo install tari-cli --git https://github.com/tari-project/tari-cli --force

# Or download from releases
curl -L https://github.com/tari-project/tari-cli/releases/latest/download/tari-cli-linux.tar.gz | tar xz

2. Create Your First Project

tari create my-first-contract

# ✅ Init configuration and directories
# ✅ Refresh project templates repository  
# ✅ Refresh wasm templates repository
# ✅ Collecting available project templates
# 🔎 Select project template: Basic - The basic project template to get started
# ✅ Generate new project

3. Add a Smart Contract

cd my-first-contract
tari new MyToken

# ✅ Init configuration and directories
# ✅ Collecting available WASM templates  
# 🔎 Select WASM template: NFT - A simple NFT template to create your own
# ✅ Generate new project
# ✅ Update Cargo.toml

4. Deploy to Network

tari deploy --account myaccount MyToken

# ✅ Building WASM template project "MyToken"
# ❓ Deploying this template costs 256875 XTR (estimated), are you sure to continue? yes
# ✅ Deploying project "MyToken" to local network  
# ⭐ Your new template's address: f807989828e70a18050e5785f30a7bd01475797d76d6b4700af175b859c32774

🎉 Congratulations! Your smart contract is live on Tari.

📚 Documentation

🎯 Essential Guides

📖 Reference

🔧 Help & Troubleshooting

🤝 Contributing

🔧 Prerequisites

Before using Tari CLI, ensure you have:

  • Tari Wallet Daemon running locally
  • Rust toolchain with wasm32-unknown-unknown target:
    rustup target add wasm32-unknown-unknown

The CLI automatically detects your development environment and guides you through any missing setup.

🌐 Networks

  • Local Development: Perfect for testing and iteration
  • Testnet: Pre-production validation
  • Mainnet: Production deployments

See the Configuration Guide for network-specific setup.

🆘 Get Help

📊 Project Status

  • Build Status: CI
  • Test Coverage: Coverage
  • Latest Release: Release

Ready to build the future of decentralized applications? Get started now or explore our template gallery.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published