CLI Usage

curl -fsSL https://cli.gravixlayer.ai/install | sh

GRAVIXLAYER_VERSION=v0.1.0 curl -fsSL https://cli.gravixlayer.ai/install | sh

irm 'https://cli.gravixlayer.ai/install.ps1' | iex

gravixlayer --version
# or
grx --version

gravixlayer doctor

gravixlayer auth login

# Check that a key is stored and valid
gravixlayer auth status

# Or set the key for this shell only (overrides the keyring)
export GRAVIXLAYER_API_KEY="your-api-key"

# List profiles (* marks the active one)
gravixlayer config profiles

# Switch the default profile
gravixlayer config use-profile default

# Override for a single command
gravixlayer --profile staging runtime list

# Or via env
export GRAVIXLAYER_PROFILE=staging

gravixlayer config set base_url https://api.gravixlayer.ai
gravixlayer config set default_template base-small
gravixlayer config set default_cloud aws
gravixlayer config set default_region us-east-1

# Target another profile without switching
gravixlayer config set default_region westus2 --profile staging

gravixlayer config show

# Create a runtime (prints the runtime id)
gravixlayer runtime create --wait

# List sandboxes
gravixlayer runtime list

# Machine-readable output (global flag)
gravixlayer --output json runtime list

# Run a one-liner inside the sandbox
gravixlayer runtime exec <runtime-id> python -c 'print(2 + 2)'

# Or run code inline (no file upload needed)
gravixlayer runtime run <runtime-id> --code 'print(2 + 2)'

# Or upload and run a local script file
gravixlayer runtime run <runtime-id> ./hello.py

# Interactive shell
gravixlayer runtime shell <runtime-id>

# Terminate when finished
gravixlayer runtime kill <runtime-id>

# Start in the background — returns the command record (incl. its pid)
gravixlayer runtime exec <runtime-id> --background --timeout 0 -- sleep 300

# Inspect, re-attach, stop
gravixlayer runtime commands list <runtime-id>
gravixlayer runtime commands attach <runtime-id> <pid>
gravixlayer runtime commands kill <runtime-id> <pid> --signal TERM

# Capture a running runtime (default kind is cold — disk only)
gravixlayer snapshot create --name after-warmup --runtime-id <runtime-id> --kind cold

# Start a new runtime from that snapshot
gravixlayer runtime create --snapshot after-warmup --wait

# List, inspect, deactivate, delete
gravixlayer snapshot list
gravixlayer snapshot get after-warmup
gravixlayer snapshot deactivate after-warmup
gravixlayer snapshot delete after-warmup -y

# N children from a running runtime
gravixlayer runtime fork <runtime-id> --count 3

# Or from a saved snapshot (parent need not be alive)
gravixlayer snapshot fork after-warmup --count 2

# Write a file (path then content)
gravixlayer runtime files write <runtime-id> /workspace/hello.txt 'Hello'

# Read it back
gravixlayer runtime files cat <runtime-id> /workspace/hello.txt

# List the workspace
gravixlayer runtime files ls <runtime-id> /workspace

# Delete a file — add -r for directories
gravixlayer runtime files rm <runtime-id> /workspace/hello.txt -y
gravixlayer runtime files rm <runtime-id> /workspace/tmp -r -y

# Check for a newer release
gravixlayer update --check

# Install the latest stable release
gravixlayer update

# Install a specific version
gravixlayer update --version 0.1.1

curl -fsSL https://cli.gravixlayer.ai/install | sh

# Default install location
rm -f ~/.local/bin/gravixlayer ~/.local/bin/grx

# Optional: remove local config and cached auth
rm -rf ~/.gravixlayer

# If you previously installed under /usr/local/bin
# sudo rm -f /usr/local/bin/gravixlayer /usr/local/bin/grx

Remove-Item "$env:LOCALAPPDATA\gravixlayer" -Recurse -Force