Developer Docs
  • Getting Started
    • Xircus Web3 Protocol
    • Wallet & Authentication
    • Own Your Web3 Apps
    • Deploying Web3 Apps
    • Deploying NFT Collection
    • Minting and Importing NFTs
    • Listing and Selling NFTs
    • Supported Chains
  • Terminologies
    • DUST - Template System
      • The Presets
      • Dust
      • Dust React
      • Dust Chakra
      • Dust Radix
    • Carousel - Template Routers
    • Graphee
      • for TON Chain
  • Launching Your App
    • Quest Apps
    • NFT Marketplace Apps
    • eCommerce Apps
    • Launchpad Apps
  • TON Contracts
    • ⚡Quick Start
    • ⛏️Minter
      • Quick Start
      • Jetton
      • Jetton Non-Shard
      • NFT
      • SBT
      • Wallet
    • 🏪Marketplace
      • ⚡Quick Start
      • NFT Market
      • NFT Music Market
      • NFT Ticket Market
      • NFT Subscription Market
    • 🌱Launchpad
      • Getting Started
      • Auction Instant
      • Auction Pool
      • Auction Fair Launch
      • NFT Pre-Mint Auction Randomizer
      • NFT Allowlist Auction
    • 🛍️eCommerce
      • Checkout
      • Property Rentals
      • Fleet Courier
      • Delivery Pooling
      • Real World Assets
    • ⛰️Governance
      • Staking
      • Locker
      • Vesting Locker
      • Vesting Locker Simple
      • Proposals
    • ⛳Prediction
      • Getting Started
      • Optimistic Oracles
      • Prediction Market Factory
  • Platform Tools
    • 📃Smart Contracts
    • 🏅Open Quest & Leaderboard
    • ⚒️Web3 Minters
    • 🎨Generative NFT Creator
    • ✨NFT Auctioneer
  • App Templates
    • NFT Marketplace
    • Crowdfunding Launchpad
    • DeFi Exchange
    • Prediction Market
    • NFT Social
    • Token XP Campaigns
  • TON Blockchain
    • TON React
    • Telegram Mini dApps
  • React Reference
    • ⚡Quick Start
    • Hooks
      • useTonConnect
      • useUtils
      • useRegistry
      • useApp
      • useStorage
      • useTon
      • useTelegram
    • Recipes
      • Connect via Wallet Provider
      • Using Wallet Authentication
  • GraphQL Reference
    • ⚡Quick Start
    • Schemas
      • App
      • Currency
      • Account
      • Chain
      • Market
    • Methods
      • Get Apps
      • Get App
  • Core SDK Reference
    • ⚡Quick Start
    • Methods
  • Xircus CLI
    • ⚡Quick Start
    • Commands
      • Create
      • App
      • Contract
      • Skin
      • Module
  • DUST App Template Building
    • Getting Started
    • Dust Chakra Common
      • AppBrand / AppHeader
      • EditableFields
Powered by GitBook
On this page
  • Introduction
  • Installation
  • Using Xircus Command on Terminal
  • Using NPX (Node Package Exectuble)
  1. Xircus CLI

Quick Start

Command Line Interface

Introduction

Xircus CLI consists of executable command line interface to create web3 apps, compile and publish smart contracts, create and publish skins, create and publish module blocks and upload apps to decentralized file system (IPFS)

Installation

yarn add xircus -g
npm install xircus -g

Using Xircus Command on Terminal

After installation, you can start using the node executable:

xircus create

Using NPX (Node Package Exectuble)

Alternatively, you can call the xircus executable on the fly using the npx command

npx xircus create

PreviousMethodsNextCommands

Last updated 1 year ago

⚡