Up & Down Commands

The up and down commands provide a streamlined way to manage your agent's lifecycle on Agent Cloud.

Up

The up command is a powerful command that performs the build, push, and deploy actions together in a single command. This significantly speeds up the development-to-deployment workflow by replacing three separate steps with one.

Usage

videosdk agent up [OPTIONS]

Options

Option	Short	Description	Default
--image	-i	Image name with tag (e.g., myrepo/myagent:v1)	From videosdk.yaml
--file	-f	Path to Dockerfile	./Dockerfile
--server	-s	Registry server URL (switches to your own registry)	VideoSDK registry
--username	-u	Registry username for authentication	None
--password	-p	Registry password for authentication	None
--managed		Force push to the VideoSDK registry	Auto-detected
--skip-build		Skip build step (use existing local image)	-
--skip-push		Skip push step (image already in registry)	-

What Happens

1. Build: The CLI builds the Docker image for the linux/arm64 platform locally (unless --skip-build is used).
2. Push: The CLI pushes the image to a registry (unless --skip-push is used). By default this is VideoSDK Cloud; pass --server with -u/-p, or use an image name that includes a registry host, to push to your own registry instead.
3. Deploy: The CLI creates and activates a new version on Agent Cloud using the image.

tip

When you push to VideoSDK Cloud (the default), it pulls the image automatically, so no image pull secret is required. See VideoSDK Registry.

Example Output

$ videosdk agent up --image myrepo/myagent:v1

◆ Step 1/3 — Building Docker Image

  Platform    linux/arm64
  Image       myrepo/myagent:v1
  Dockerfile  /path/to/your/project/Dockerfile

────────────────────────────────────────

[Docker build output...]

✓ Successfully built image: myrepo/myagent:v1

◆ Step 2/3 — Pushing Docker Image

  Registry  vcr.videosdk.live
  Image     vcr.videosdk.live/<your-project>/myagent:v1

────────────────────────────────────────

[Docker push output...]

✓ Pushed image: vcr.videosdk.live/<your-project>/myagent:v1

◆ Step 3/3 — Deploying Agent

  Agent ID: ag_xxxxxx
  Image: vcr.videosdk.live/<your-project>/myagent:v1
  Min Replicas: 1
  Max Replicas: 3
  Profile: cpu-small
────────────────────────────────────────────────────────────
Creating Version ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:01

✓ Agent is up!
  Version ID: v_xxxxxx
ℹ Check status:
  videosdk agent version status
ℹ View logs:
  videosdk agent logs
ℹ Take it down:
  videosdk agent down

Examples

# Build, push, and deploy using defaults from videosdk.yaml
videosdk agent up

# Build, push to VideoSDK Cloud, and deploy (no pull secret needed)
videosdk agent up --image my-agent:v1

# Specify your own registry and credentials
videosdk agent up --image myrepo/myagent:v1 -s docker.io -u username -p password

# Skip build and use existing image
videosdk agent up --image myrepo/myagent:v1 --skip-build

# Skip build and push, only deploy
videosdk agent up --image myrepo/myagent:v1 --skip-build --skip-push

---

Down

The down command deactivates all running versions of a specific agent. This is the quickest way to stop all active instances of your agent across all deployed versions.

Usage

videosdk agent down [OPTIONS]

Options

Option	Short	Description	Default
--force		Force deactivate even with active sessions	No
--yes	-y	Skip confirmation prompt	No

What Happens

1. Version Identification: The CLI identifies all active versions for the specified agent (from videosdk.yaml).
2. Deactivation: It sends a deactivation request for every active version.
3. Session Transition: Once deactivated, these versions will stop receiving new sessions. Existing sessions will continue until they finish (unless --force is used).

Example Output

$ videosdk agent down

◆ Bringing Agent Down


Found 1 active version(s):

  • v_xxxxxx — my-agent's version

Deactivate 1 version(s)? [y/N]: y

Deactivating v_xxxxxx ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
✓ Deactivated v_xxxxxx

✓ Agent is down. All versions deactivated.

Examples

# Graceful deactivation with confirmation
videosdk agent down

# Force deactivation (terminates active sessions)
videosdk agent down --force

# Skip confirmation prompt
videosdk agent down -y

---

Next Steps

• Learn more about individual Build & Push commands.
• Explore detailed Deployment & Version management.