Skip to main content

Installation

Authentication

Login

The login command provides two authentication methods:
  • Browser-based authentication (recommended)
  • Manual API key entry from the Valyent dashboard

Logout

Removes stored credentials from your machine.

Project Initialization

Initialize a New Project

Creates a new valyent.json configuration file in your current directory. You can either:
  • Specify a fleet ID directly using the --fleet flag
  • Select an existing fleet or create a new one through an interactive prompt

Fleets

Fleets are groups of machines that can be managed together.

Create a Fleet

List Fleets

Delete a Fleet

Machines

Machines are the compute instances running your workloads.

List Machines

Create a Machine

Example machine configuration (machine-config.json):
Configuration fields:
  • region: The region where the machine will be deployed (e.g., “gra-1”)
  • skip_start: Whether to skip starting the machine after creation
  • config:
    • image: Docker image to use for the machine
    • workload:
      • env: Array of environment variables
      • restart.policy: Container restart policy
      • init.user: User to run the container as
    • gateway_enabled: Whether to enable gateway access
    • guest:
      • cpu_kind: Type of CPU (“eco” for economical)
      • cpus: Number of CPU cores
      • memory_mb: Memory allocation in megabytes

Machine Operations

Gateways

Gateways manage incoming traffic to your applications.

Create a Gateway

Interactive prompt will ask for:
  • Gateway name
  • Target port

List Gateways

Delete a Gateway

Environment Variables

List Environment Variables

Set Environment Variables

Example:

Load Environment Variables from File

Supports loading variables from files like .env

Deployment

Deploy Project

Deploys your project to Valyent by:
  1. Reading the project configuration from valyent.json
  2. Creating a tarball of your codebase (excluding .git, node_modules, and paths in .dockerignore)
  3. Uploading and creating a new deployment
  4. Streaming build logs in real-time

Open Deployed Application

Opens your deployed application in the default web browser.

Notes

  • The CLI supports various aliases for commands (e.g., fleet for fleets, gateway for gateways)
  • Most commands that require a fleet ID will prompt you to select one if not specified
  • The CLI includes built-in confirmation prompts for destructive operations
  • Environment variables can be loaded from .env files or set individually
  • Build and deployment logs are streamed in real-time for better visibility