Skip to content
vvd
Start building
Get started— browse docs
On this page

vvd CLI

Install the vvd CLI and learn the core commands for building, running, and publishing your creations.

You'll need a vvd account and a world to build against. If you don't have one yet, sign up at beta.vvd.world and create a world first — it takes a minute, and every command below runs against it.

Install

Install the CLI with a single command:

Install the vvd CLI

curl -fsSL https://beta.vvd.world/cli/install.sh | sh

Sign in — paste the one-time code from the Workshop

vvd login

to jump straight to your one-time code — or open the Workshop in vvd and copy it from the Developer tab.

Verify the installation:

vvd version
Expected output: 
  ● vvd v0.8.11
Note:

See Installation for more installation options and troubleshooting.

Authenticate

Log in to connect the CLI to your vvd account:

vvd login --token vvd_otc_7f3c1a92

The one-time code comes from Workshop → Developer inside any of your worlds. Your credentials are stored securely in your home directory and never leave your machine. See Authentication for details on managing login sessions and credentials.

What you can do

ToolsBuild collaborative editors that run inside any worldAppsBuild full-screen experiences that own a whole spaceWikisPublish a world as a themed public siteWorldsCreate and query worlds and documents from the terminal

Create and run a project

Scaffold a project and watch it run live inside a real world, hot-reloading as you save. Scaffolding works offline; vvd run and everything after it needs you signed in:

vvd create my-tool --tool
cd my-tool
vvd run

See Build your first tool for a step-by-step walkthrough of what those files are and why.

Save, share, and publish

Build an immutable version, let your world use it, then submit it to the Workshop:

vvd save "First version"
vvd share
vvd publish

Change your mind later with vvd unpublish, or take a creation out of a world with vvd remove. See Ship it for how the three stages differ.

Work with worlds from the terminal

Create worlds and documents, and search a world's content, without opening the app:

vvd worlds create "My World"
vvd docs create my-world "Field notes"
vvd search my-world "ember"

See the Command reference for every command and flag.

Next steps

InstallationAlternative install options, verification, and troubleshooting.AuthenticationManage login sessions and credentials.Build your first toolCreate and run your first collaborative tool, step by step.Command referenceFull reference for every vvd command.