Skip to content

Commands


wal-dev CLI Command Development Tools

wal is a command-line interface (CLI) tool designed to simplify testing and interaction with the Walrus. This CLI tool provides a fast and easy way to interact with the Sui blockchain, allowing you to perform tasks such as swap tokens, blob on walrus, and interacting with smart contracts.

Preview

Demo only using wal-dev (wal) command. Please do not show Privatekey.

Install

To use wal-dev, you'll need to install it globally via npm.

bash
npm i -g wal-dev

Call

After installing, you can call wal from your terminal using the available commands.

wal
wal
wal-dev
wal-dev
wd
wd
walrus
walrus

Use

You can type the following command. to see additional required options.

balance

Check the SUI and WAL token balance of an address.

bash
wal balance

get

Swap SUI <-> WAL tokens at a 1:1 rate (testnet only).

bash
wal get

upload

Upload file with "Path:/to/x.x" or "text" on Walrus.

bash
wal upload

read

Preview data from Walrus using blob ID.

bash
wal read

start

Start a local:3000 Walrus server for testing.

bash
wal start

download

Download file from Walrus using blob ID.

bash
wal download

Syntax

Additional options in each desired use.

WARNING

⚠️ Never share your private key, Anyone with access can fully control your wallet.
      This section uses the Sui SDK official

SyntaxDescription
<address>The wallet address to check
<amount>Amount to swap (e.g., 0.1)
<data>File "Path:/to/x.x" or "text" to upload
<blobID>The blobId of the file to read
-pk, --privateKey <key>Private key sign the transaction
-n, --network <network>Specify network mainnet or testnet
-t, --token <token>Token to receive: wal or sui

Keyword

Explain the meaning of each command.

KeywordDescription
walMain command used to run the wal-dev CLI tool
balanceCheck the SUI and WAL token balance of an address
getSwap SUI <-> WAL tokens at a 1:1 rate (testnet only)
uoloadUpload file with "Path:/to/x.x" or "text" on Walrus
readPreview data from Walrus using blob ID
startStart a local:3000 Walrus server for testing
downloadDownload file from Walrus using blob ID

Note

Help remember more.

  • ⚠️ Never reveal your Private Key can control the wallet and all transactions.
  • 🔧 wal-dev is a CLI tool for working with Walrus Protocol on SUI Blockchain.
  • 🛠️ If there is an error or want to see all commands, use wal <Keyword>.
  • 📁 Using wal upload supports both files ("Path:/to/x.x") and text ("Text").