VSL CLI Reference

The VSL CLI (vsl-cli) is the primary tool for interacting with the Verifiable Settlement Layer (VSL). Whether you're running a local node, testing claim submissions, or building automation workflows, the CLI gives you full control over VSL operations.

This page gives you an overview of what the CLI can do, how to get started, and where to find in-depth usage instructions.

Why Use the CLI?

The CLI is ideal for:

• Spinning up local environments for testing

• Managing identities and accounts quickly

• Creating and transferring both native and custom assets

• Submitting and verifying claims in a test or devnet environment

• Scripting repeatable interactions via REPL or batch files

It is especially helpful during early prototyping phases, where working through the VSL programmatically helps surface edge cases and gaps in implementation.

How the CLI Works

The CLI launches into an interactive REPL mode where you can enter VSL-specific commands in real-time. You can also run these commands as part of a script or batch job.

Most commands follow a consistent structure:

vsl> <resource>:<action> [--flag value]

Example:

vsl> account:create alice

This design is intentional, to keep the CLI readable, script-friendly, and logically grouped.

Key Capabilities

Category	What You Can Do
Network	Launch a local server, connect to remote nodes
Accounts	Create, fund, and switch between user accounts
Assets	Create new tokens, transfer them between users
Claims	Submit proofs, view pending claims, settle verified ones
REPL Mode	Run commands interactively with optional logging
Batch Execution	Pipe tutorials or scripts directly into the CLI

How to Get Started

Run this command to enter REPL mode with a temporary config:

vsl-cli repl --tmp-config

From there, you can:

• Add a network

• Create accounts

• Mint and transfer assets

• Submit and verify claims

All of these are demonstrated in the official CLI tutorial.

Official Documentation

All resources that you need to use the CLI have been properly documented on our GitHub repository and you can find them here:

• Command Reference: Browse a full list of CLI commands with arguments, options, and examples.

• Tutorials: Follow a guided walkthrough covering key CLI workflows like asset creation and claim settlement.

Pro Tips

Here are a few helpful tips when working with the CLI:

• Need help on a command? Use --help with any command:

vsl> account:create --help

• REPL logging: To print each command as it executes (great for scripts), start REPL with:

vsl-cli repl --print-commands

• Batch processing: Automate workflows by running .vsl or .sh scripts:

vsl-cli repl --print-commands < docs/tutorial.vsl

• Exploration: Use commands like account:current, asset:balances, and claim:submitted to inspect current state.

Working with Devnet

To connect to the devnet environment, use:

vsl> network:add devnet --url http://<devnet-url>
vsl> network:use devnet

You’ll need to configure accounts and assets manually or use a faucet if available.

Source Code & Issues

The CLI tool is maintained on GitHub: Pi-Squared-Inc/vsl-cli

Found a bug or want to suggest an improvement? Open an issue or pull request in the repo.