mezcal-cli

🌵 mezcal-cli

The mezcal-cli is an interactive command‑line tool for managing a bitcoin mezcal wallet and interacting with Mezcal assets. It supports wallet generation, recovery, switching addresses, querying balances, transferring funds, minting and etching Mezcal tokens, configuration management, and more.

🌵 Installation

• Install Node.js (v18 or higher).

• On your command line terminal, run:

  npm install -g mezcal-cli
  

• Youre all set! You can now use the mezcal command in your terminal. To view the commands you can call, run

  mezcal --help
  

🌵 Command Reference

The CLI command is invoked as mezcal. Below are the available commands along with usage examples:

Wallet Commands

• Generate a New Address

  • Generates a new wallet address (or switches to the next index if a wallet already exists).
  • Usage:

    mezcal wallet generate
    

  • Example output shows the new wallet index and address.

• Recover a Wallet

  • Recovers a wallet from a 12‑word mnemonic phrase.
  • Usage:

    mezcal wallet recover
    

  • Follow the prompts to enter your mnemonic phrase and set a password.

• Reveal Mnemonic

  • Displays the mnemonic phrase for your active wallet.
  • Usage:

    mezcal wallet reveal
    

• Show Wallet Info

  • Displays the current wallet address.
  • Usage:

    mezcal wallet info
    

• Switch Wallet

  • Switches to another HD wallet index.
  • Usage:

    mezcal wallet switch <index>
    

  • Example:

    mezcal wallet switch 2
    

• List Wallets

  • Lists all generated wallet addresses and their balances.
  • Usage:

    mezcal wallets
    

Balance & Transfer Commands

• Balance

  • Display confirmed BTC and Mezcal balances for your wallet address.
  • Usage:

    mezcal balance
    

• Transfer

  • Interactively build and broadcast BTC and/or Mezcal transfers.
  • Usage:

    mezcal transfer
    

  • Follow the interactive prompts to enter transfer details.

Mezcal Asset Commands

• Mezcal Info

  • Shows metadata and the top holders for a Mezcal asset.
  • Usage:

    mezcal info <block:tx | mezcalName>
    

  • Example:

    mezcal info 859:1
    

= Discover mezcal =

• Mezcal List

  • Lists all Mezcals on the network.
  • Usage:

    mezcal all <protocol>
    

• Holders

  • Lists holders for a specific Mezcal asset.
  • Usage:

    mezcal holders <block:tx | mezcalName> [page]
    

  • Example:

    mezcal holders 859:1 3
    

• Mint

  • Mint a Mezcal token that you have already etched (if mintable).
  • Usage:

    mezcal mint <block:tx | mezcalName>
    

  • Follows prompts for mint cost and confirmation.

• Etch

  • Create a Mezcalstone etching and build a transaction.
  • Usage:

    mezcal etch
    

  • A guided wizard walks you through setting etching properties.

Configuration Commands

• Set Configuration

  • Set Electrum API URL, Mezcals RPC URL, or Network (bitcoin | testnet | regtest).
  • Usage:

    mezcal config set --electrum <url> --mezcal <url> --network <env>
    

  • Example:

    mezcal config set --electrum https://regtest.anoa.io/api --network regtest
    

• Show Configuration

  • Display the current Mezcals CLI configuration.
  • Usage:

    mezcal config show
    

  • You may also run:

    mezcal config
    

For more details or to report issues, please visit the GitHub Issue Tracker.