Install VirtualBoard CLI

Download the latest release for your platform

Download Latest Release

Choose the binary for your platform and architecture:

Installation Instructions

macOS

After downloading the appropriate binary for your Mac (ARM64 for Apple Silicon, AMD64 for Intel):

  1. Open Terminal
  2. Navigate to your Downloads folder:
    cd ~/Downloads
  3. Move the binary to /usr/local/bin and rename it to vb:
    # For Apple Silicon (ARM64)
    sudo mv vb-macos-arm64 /usr/local/bin/vb
    
    # OR for Intel (AMD64)
    sudo mv vb-macos-amd64 /usr/local/bin/vb
  4. Make the binary executable:
    sudo chmod +x /usr/local/bin/vb
  5. Verify the installation:
    vb version

Note: If you get a security warning when first running vb, go to System Preferences → Security & Privacy → General and click "Allow Anyway".

Linux

After downloading the appropriate binary for your system (AMD64 or ARM64):

  1. Open your terminal
  2. Navigate to your Downloads folder:
    cd ~/Downloads
  3. Move the binary to /usr/local/bin and rename it to vb:
    # For AMD64
    sudo mv vb-linux-amd64 /usr/local/bin/vb
    
    # OR for ARM64
    sudo mv vb-linux-arm64 /usr/local/bin/vb
  4. Make the binary executable:
    sudo chmod +x /usr/local/bin/vb
  5. Verify the installation:
    vb version

Windows

After downloading vb-windows-amd64.exe:

  1. Rename the downloaded file to vb.exe
  2. Move vb.exe to a directory in your PATH (e.g., C:\Windows\System32 or create a C:\bin directory and add it to your PATH)
  3. Open Command Prompt or PowerShell and verify the installation:
    vb version

Alternative: You can also place vb.exe in any directory and run it using the full path, or add that directory to your system PATH.

Next Steps

Once installed, initialize a VirtualBoard workspace in your repository:

vb init
vb --help

Visit the Workflow page to learn how to use VirtualBoard CLI effectively.