Skip to content

Latest commit

 

History

History
169 lines (127 loc) · 7.73 KB

README.md

File metadata and controls

169 lines (127 loc) · 7.73 KB

📚 Tari CLI Documentation

Complete documentation for developing smart contracts on the Tari blockchain

Welcome to the comprehensive Tari CLI documentation! Whether you're new to smart contract development or an experienced blockchain developer, these guides will help you build powerful decentralized applications on Tari.

🚀 Quick Navigation

🎯 New to Tari CLI?

📖 Essential Guides

📋 Reference Materials

🔧 Troubleshooting & Help

🤝 Contributing

🗺️ Documentation Map

📚 Tari CLI Documentation
├── 🚀 Getting Started
│   ├── Installation & Setup............. Complete environment setup
│   ├── Quick Start Guide................ First contract in 10 minutes  
│   └── Development Workflow............. Full development cycle
├── 📖 Guides
│   ├── Template Development............. Custom smart contract creation
│   ├── Project Configuration............ Network and project setup
│   └── Deployment Guide................ Blockchain deployment
├── 📋 Reference
│   ├── CLI Commands.................... Complete command reference
│   ├── Configuration Schema............ All config options
│   └── API Patterns.................... Real implementation examples
├── 🔧 Troubleshooting
│   ├── Common Issues................... Frequent problem solutions
│   ├── Advanced Debugging.............. Deep troubleshooting
│   └── FAQ............................. Frequently asked questions
└── 🤝 Contributing
    ├── Development Setup............... Contributor environment
    └── Testing Guide................... Test practices

🎯 Choose Your Path

🌟 I'm brand new to Tari

Start here: Installation & Setup → Quick Start

You'll learn: How to install Tari CLI, create your first project, and deploy a smart contract

🔨 I want to build custom templates

Start here: Template Development Guide

You'll learn: How to create reusable smart contract templates for specific use cases

⚙️ I need to configure complex setups

Start here: Project Configuration → Configuration Schema

You'll learn: Advanced configuration for multiple networks, custom environments, and CI/CD

🚀 I'm ready to deploy to production

Start here: Deployment Guide

You'll learn: Best practices for mainnet deployment, security considerations, and monitoring

🐛 I'm having issues

Start here: Common Issues

You'll find: Solutions to the most frequent problems and debugging techniques

🤝 I want to contribute

Start here: Development Setup

You'll learn: How to set up a development environment and contribute to Tari CLI

🔄 Development Workflow Overview

graph TB
    A[Install Tari CLI] --> B[Create Project]
    B --> C[Generate Templates]
    C --> D[Develop Contracts]
    D --> E[Test & Compile]
    E --> F[Deploy to Network]
    F --> G[Monitor & Iterate]
    G --> D
    
    style A fill:#e1f5fe
    style F fill:#e8f5e8
    style G fill:#fff3e0
Loading

Typical Development Flow:

  1. Install - Set up development environment
  2. Create - Initialize new project workspace
  3. Generate - Create smart contracts from templates
  4. Develop - Implement custom business logic
  5. Test - Verify WASM compilation
  6. Deploy - Publish to blockchain
  7. Monitor - Track performance and usage

📊 Documentation Quality

All documentation in this repository follows strict accuracy standards:

✅ Verified Examples: All code examples are extracted from actual test files or implementation
✅ Real Error Messages: Error messages match actual CLI output
✅ Tested Commands: All CLI commands are verified against current implementation
✅ Source References: Major examples include source file references
✅ Regular Updates: Documentation is updated with each release

🆘 Getting Help

📞 Quick Help

🤝 Community Support

💡 Improve Documentation

Found something unclear or missing? We welcome contributions!

🏆 Success Stories

What you can build with Tari CLI:

  • NFT Marketplaces: Unique digital asset platforms
  • Token Systems: Custom cryptocurrency implementations
  • DeFi Protocols: Decentralized finance applications
  • DAOs: Decentralized autonomous organizations
  • Gaming Assets: In-game items and economies

📈 Latest Updates

Documentation Version: Latest (main branch)
Last Major Update: 2025-06-26
CLI Version Compatibility: All current versions

Recent Improvements:

  • ✨ Comprehensive CLI command reference
  • ✨ Enhanced troubleshooting guides with verified solutions
  • ✨ Step-by-step quick start workflow
  • ✨ Visual workflow diagrams
  • ✨ Real examples from test files

Ready to start building? Begin with our Quick Start Guide and deploy your first smart contract in minutes!