Installation

First make sure you have tsx installed globally on your machine.

npm i tsx -g

Setting up Flow is as simple as opening your favourite terminal application and cloning the git repo and run the following commands.

git clone https://github.com/Galliun/flow.git

change into the directory.

cd flow

then install the node packages

npm i

then install flow as a command line tool

npm i -g

and you are ready to go.

Flow contains a collection of commands for creating and managing Water Coolers. The complete list of commands can be viewed by running on your command line:

flow

This will display a list of commands and their short description:

Usage: flow [options] [command]

Options:
  -V, --version    output the version number
  -h, --help       display help for command

Commands:
  network          Gives information on the sui network
  switch <string>  Switch connected Sui network to testnet or mainnet
  balance          Get connected wallet balance
  faucet           Request Sui from network faucet
  address          View current address
  price            Get Water Cooler price from the Cooler factory
  buy              Buy a Water Cooler from the Cooler factory
  init             Initiate Water Cooler for mint
  details          Returns the IDs of objects needed to mint NFTs
  stock            Stock NFTs in Water Cooler warehouse in preperation for mint
  reveal           Reveal the NFT images and attributes
  set [options]    Change setting on your Water Cooler
  dist [options]   Distribute OG and WL tickers for your NFT mint
  help [command]   display help for command

To get more information about a particular command (e.g., `set``), use the help command:

Usage: flow set [options]

Change setting on your Water Cooler

Options:
  -a, --amount <amount>  Change the NFT mint price. Price must be sent in mist: e.g. 10.5 $SUI = 10.5*10^9
  -p, --phase <phase>    Change the current phase of the Water Cooler. e.g. 0: unset, 1: OG, 2: WL, 3: public mint
  -s, --status <status>  Change the status of the mint. e.g. 0: inactive, 1: active
  -h, --help             display help for command