Skip to main content

CLI and SDK for JarvisLabs.ai GPU cloud

Project description

jarvislabs

Python License

CLI and Python SDK for managing GPU instances on JarvisLabs.ai.

See the docs on Jarvislabs Docs

Installation

As a CLI tool (recommended)

uv tool install jarvislabs

To upgrade:

uv tool upgrade jarvislabs

As a library

pip install jarvislabs

Or with uv:

uv pip install jarvislabs

Requires Python 3.10+.

Authentication

Get your API key at jarvislabs.ai/settings/api-keys.

jl setup

Or set an environment variable:

export JL_API_KEY="your_api_key"

CLI Quick Start

# See available GPUs and pricing
jl gpus

# Create a container instance (pre-configured with PyTorch, Jupyter, IDE)
jl create --gpu A100 --name "my-instance"

# Create a VM instance (bare-metal SSH access)
jl create --gpu A100-80GB --vm --name "my-vm"

# Create an instance and expose a custom HTTP port
jl create --gpu L4 --http-ports 7860

# SSH into it
jl ssh <machine_id>

# Pause when done (stops compute billing, data persists)
jl pause <machine_id>

# Resume later — optionally with different hardware
jl resume <machine_id> --gpu H100

# Destroy when no longer needed
jl destroy <machine_id>

Managed Runs

Run scripts on GPU instances without manual setup. Code is uploaded, a virtual environment is created (with template packages like torch visible by default), and logs are tracked automatically.

For humans, the default mode stays attached to the run, streams logs, and can auto-pause or auto-destroy the instance after the run finishes. For agents, --json is meant for detached workflows and returns immediately, so use --keep and have the agent pause or destroy the instance after the run.

# Run a training script on a fresh GPU (instance auto-pauses when done)
jl run train.py --gpu L4

# Start a long-running web app on a fresh GPU and expose port 8000
jl run app.py --gpu L4 --http-ports 8000 --keep --no-follow

# Pass script arguments
jl run train.py --gpu L4 -- --epochs 50 --lr 0.001

# Sync a project directory and run a script inside it
jl run . --script train.py --gpu A100 --requirements requirements.txt

# Run on an existing instance
jl run train.py --on <machine_id>

# Check on a run
jl run logs <run_id> --follow
jl run status <run_id>
jl run stop <run_id>

More Commands

jl status                   # Account info and balance
jl templates                # Available framework templates
jl list            # List all instances
jl exec <id> -- nvidia-smi   # Run a command remotely
jl upload <id> ./data        # Upload files
jl download <id> /home/results.csv  # Download files
jl ssh-key add ~/.ssh/id_ed25519.pub --name "my-key"
jl scripts add ./setup.sh --name "install-deps"
jl filesystem create --name "datasets" --storage 200
jl get <id>                  # Shows Jupyter + exposed port URLs

Every command supports --help, --json (machine-readable output), and --yes (skip confirmations).

Python SDK

from jarvislabs import Client

with Client() as client:
    # Create a GPU instance (blocks until running)
    inst = client.instances.create(gpu_type="A100", name="my-run")
    print(f"SSH: {inst.ssh_command}")
    print(f"URL: {inst.url}")

    # When done
    client.instances.pause(inst.machine_id)
from jarvislabs import Client

with Client() as client:
    # List and filter instances
    running = [i for i in client.instances.list() if i.status == "Running"]

    # Check GPU availability and pricing
    for gpu in client.account.gpu_availability():
        print(f"{gpu.gpu_type}: {gpu.num_free_devices} free, ${gpu.price_per_hour}/hr")

    # Manage filesystems
    fs_id = client.filesystems.create(fs_name="data", storage=100)

    # Manage startup scripts
    client.scripts.add(script="#!/bin/bash\npip install wandb", name="setup")

Development

uv pip install -e ".[dev]"
uv run ruff format . && uv run ruff check --fix .
uv run pytest

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jarvislabs-0.2.14.tar.gz (55.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jarvislabs-0.2.14-py3-none-any.whl (63.2 kB view details)

Uploaded Python 3

File details

Details for the file jarvislabs-0.2.14.tar.gz.

File metadata

  • Download URL: jarvislabs-0.2.14.tar.gz
  • Upload date:
  • Size: 55.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for jarvislabs-0.2.14.tar.gz
Algorithm Hash digest
SHA256 1b09246fca528dc17312853c59287b6d4fcea670c46d53f3a3f40235a3b0aab7
MD5 9f555e6ad8a150454e71847991185025
BLAKE2b-256 d6fe65ccaf0c404ab47c7d973efa0f0fc0ba19a10296e0558b5f1bf2d25a2d08

See more details on using hashes here.

File details

Details for the file jarvislabs-0.2.14-py3-none-any.whl.

File metadata

  • Download URL: jarvislabs-0.2.14-py3-none-any.whl
  • Upload date:
  • Size: 63.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for jarvislabs-0.2.14-py3-none-any.whl
Algorithm Hash digest
SHA256 8c22968a89630118830ae7e3f0f963c4e92d78557e93b779ea1bf9788d4a5b26
MD5 06b1d69571fa823a6207c99c6ec5b3d4
BLAKE2b-256 11ee44792f6cd54ae3a7a5636f94d450f28599a3332e680fd28e2101d544e9a3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page