deploy_artifact
The primary tool for deploying web artifacts to the cluster.
Input Schema
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Unique DNS-safe name (lowercase, hyphens OK) |
files | object | Yes | Map of relative file paths to file content. Tip: Provide a Dockerfile at the root to completely customize the build. |
language | string | No | Language hint (nodejs, python, go, static) |
target | string | No | Deployment target (auto, sandbox, kubernetes) |
env_vars | object | No | Environment variables for the artifact |
secret_refs | object | No | Map of env var name to K8s Secret reference (secret-name:key) |
port | number | No | Port the app listens on (auto-detected) |
Example
{
"name": "my-portfolio",
"files": {
"index.html": "<!DOCTYPE html><html>...</html>",
"style.css": "body { font-family: sans-serif; }",
"app.js": "console.log('Hello from vibeD!');"
},
"target": "auto"
}
Response
{
"artifact_id": "a1b2c3d4e5f6g7h8",
"name": "my-portfolio",
"url": "http://my-portfolio.default.localhost",
"status": "running"
}
What Happens
- Validates the name (DNS-safe, unique).
- Stores the source tarball to the configured source store.
- Classifies the source into a lane and template.
- Creates a
VibedAppand the controller claims a warm sandbox and injects the source — no container build on the deploy path. - Returns the access URL once the app reaches
Ready(or astatus_urlto poll if it took a slow path).
See App lifecycle for the phases the app moves through.