hatch-cli

HATCH CLI

This documentation will be focused on all the cli commands available to you. For a more detailed walkthrough of how to set up and launch you project go to our client repository.

Requirements

• Node >= 16

Installation

npm install -g hatch-cli

Run hatch-cli to see all the commands available to you. Run hatch-cli help [command] to display information for a command.

General usage: hatch-cli [command] [options] <subcommand>

Commands

mint

Mint assets and metadata to canister. hatch-cli mint [options]

• -p, --parallel Mint in parallel. This means that the order of the NFTs in your folder is not guaranteed. (default: false)
• -d, --delay <delay> Time (in ms) to delay between subsequent mint requests (default 500). Only affects minting when parallel is set to true (default: "500")
• -v, --verbose Flag to determine whether to print more detailed logging statements as you mint.

unpin

Unpin all assets from ifps. hatch-cli unpin

identity

Create/display your identity. hatch-cli identity

init

Initialize NFT canister with proper ownership data. You need 2 WICP in your minting account. hatch-cli init

sale

Initialize sale information. hatch-cli sale [options]

• -f, --force Force a sale reset even after setting it up already. You are not able to reset the sale if the sale has already begun. (default: false)

validate

Validate metadata and assets. This ensures your metadata/assets match up. hatch-cli validate

whitelist

Set up whitelist from config/whitelist.json. hatch-cli whitelist

links

Set up external links (gif, social media, etc.) from config/links.json. hatch-cli links

wicp

Some simple WICP utils to check balance and wrap ICP. hatch-cli wicp [options] <action> Options:

• -m, --amount <amt>. Amount of WICP to wrap/unwrap. (default: "1")
• -a, --all. Flag representing whether to process all of your WICP balance in the minting account. (default: false)

Actions: <action> Action to perform (wrap/unwrap/balance/creatorBalance/claim).

• wrap. Wraps a certain amount of ICP in the minting account to WICP.
• unwrap. Unwrap a certain amount of ICP in the minting account to WICP. This unwraps back to your creator wallet address.
• balance. Returns how much WICP you have in your minting account.
• creatorBalance. Returns how much WICP you can claim from your nft canister. This includes marketplace royalties and launchpad sale funds.
• claim. This claims all your WICP credit from the nft canister. The WICP is delivered to your creator principal.