APIGENERAL
OVERVIEW
Home
COMMAND LINE INTERFACE
Vatom CLI
REFERENCE
Glossary
Documentation Changelog
Subscribe to Updates
System Status

Common Developer Patterns

Confirm Developer Privileges
Expose Your Brand
Build a Sample App with Vite

Firehose

About Firehose Events
Game Events
Token Events
User Events
Campaign Events
Message Events
Space Events
System Events
Change LogForum

Add API Credentials

Request by sending an email to developer@vatom.com

Cancel

Vatom CLI

Before installing the @vatom/cli, check to see if you already have the necessary system requirements by running which node and which npm

Prerequisites

  1. Sign Up: To begin development, you must first create a Vatom Account by registering at studio.vatom.com

  2. Get your Business ID: When creating a Vatom account, you are creating a business account. Every business has its associated business ID. This business ID will allow you to use the CLI tool.

    To find your business ID go to: Studio > Profile Icon (top right corner) > Settings > Profile. Copy this ID down for ease of use.

Note: When using the CLI to create plugins on the Vatom Market, there are additional prerequisites that must be met. Please see the Plugin Documentation for more information.

Installing the Vatom CLI

  1. Ensure that you have Node installed:

  2. Install the CLI by running npm install --global @vatom/cli@latest

    Note: If you don't want to install it globally you can run it with NPX instead, by prepending npx -p @vatom/cli to every vatom command you run.

    For example: vatom auth becomes npx -p @vatom/cli vatom auth

  3. Test it by running vatom --version.

Authentication

Once everything is installed, authorize your Vatom Account by running the command vatom auth.

This will open a tab in your browser that will let you sign in. If the sign-in process is successful, you will see the success message as seen below.

✔ You have successfully authenticated the Vatom CLI to your Vatom Studio account.

Known Issue With Some Firewalls

If you are working behind a highly restrictive firewall, it is possible that the CLI will issue the following error message:

  • UNABLE_TO_GET_ISSUER_CERT_LOCALLY

If so, there is a workaround. It is possible to relax restrictions applied internally by the CLI without compromising the security provided by your firewall. To use this workaround, issue the following environment variable setting from a terminal prompt:

% set NODE_TLS_REJECT_UNAUTHORIZED=0

Next steps

There are many things you can do with the Vatom CLI. Here are some examples:

  • Create plugins for Vatom Spaces. See the docs here.
  • Create Smart NFT Designs. See the docs here.
  • See a list of available commands by running vatom --help