Quickstart
Installation
Install the Vibengine SDK and CLI
Installation
Vibengine provides an SDK for programmatic sandbox management and a CLI for local development workflows.
SDK Installation
npm install vibengineRequirements: Node.js 18 or later.
import { Sandbox } from 'vibengine'pip install vibengineRequirements: Python 3.8 or later.
from vibengine import SandboxCLI Installation
The CLI is used to manage templates, authenticate, and interact with sandboxes from the terminal.
npm install -g @vibengine/cliVerify the installation:
ve --versionAuthentication
Set your API key
Get your API key from the Vibengine Dashboard and set it as an environment variable:
export VE_API_KEY=your_api_key_hereFor persistent configuration, add it to your shell profile (~/.bashrc, ~/.zshrc, etc.):
echo 'export VE_API_KEY=your_api_key_here' >> ~/.bashrcCLI Authentication
You can also authenticate the CLI interactively:
ve auth loginThis opens a browser window to authenticate with your Vibengine account.
Never commit your API key to version control. Use environment variables or a .env file (added to .gitignore).
Verify Setup
import { Sandbox } from 'vibengine'
const sandbox = await Sandbox.create()
const result = await sandbox.commands.run('echo "Setup complete!"')
console.log(result.stdout) // "Setup complete!"
await sandbox.kill()from vibengine import Sandbox
sandbox = Sandbox()
result = sandbox.commands.run('echo "Setup complete!"')
print(result.stdout) # "Setup complete!"
sandbox.kill()