Skip to main content

Connect to Vast.ai GPU instances: sync SSH configs, set up your project, and open your IDE.

Project description

Vastly

Connect to Vast.ai GPU instances from your terminal: sync SSH configs, set up your project remotely, and open your IDE in one command.

Prerequisites

  • Python 3.9+
  • Vast.ai CLI (pip install vastai) with API key configured
  • Git
  • VS Code or Cursor with the Remote-SSH extension

Install

pip install vastly

This gives you two equivalent commands: vastly and vst (shorthand). All examples below use vst.

Usage

cd your-project      # any local git repo
vst                  # checks setup -> opens IDE (sets up on first run)
vst 1xRTX4090-TW    # target a specific instance by name
vst --no-setup       # open IDE without cloning or installing anything
vst --force-setup    # re-run remote setup even if already done
vst --list           # list instances and exit
vst --version        # show version

How It Works

1. Sync

Calls the Vast.ai API and writes an SSH config for each running instance to ~/.ssh/vast.d/. On first run, adds Include vast.d/* to ~/.ssh/config.

Instances are named by GPU and region (e.g. 1xRTX4090-TW, 2xA100-US). Duplicates get the instance ID appended (1xRTX4090-TW-12345).

2. Select

One instance is selected automatically. Multiple instances prompt you to pick one or select all. You can also pass the name directly: vst 1xRTX4090-TW.

3. Setup (first run only)

For each selected instance, vst checks if the project has already been set up by looking for a marker file at ~/.vastly/setup/<repo>.json on the instance. If the marker exists, it skips straight to opening the IDE.

On first run (no marker), vst reads the remote URL from your local git repo, copies a setup script to the instance, and runs it.

The setup script (setup-remote.sh):

  • Disables auto-tmux (on by default, configurable)
  • Configures git identity from your local git config
  • Adds the git host to SSH known hosts (extracted from repo URL)
  • Clones your repo into the workspace
  • Installs Python dependencies (auto-detected)
  • Runs any configured post-install commands
  • Writes VS Code settings and patches .bashrc
  • Writes a setup marker (~/.vastly/setup/<repo>.json) so setup is skipped next time

Dependency auto-detection (checked in order):

  1. uv.lock or [tool.uv] in pyproject.toml -- uv sync (installs uv if needed)
  2. [project] in pyproject.toml -- pip install -e .
  3. requirements*.txt -- pip install -r for each file
  4. setup.py -- pip install -e .

Override with installCommand in your config.

4. Open

Launches your IDE via Remote-SSH at the project directory. If already open, focuses the existing window.

Configuration

On first run, vst creates ~/.vastly.json with defaults:

{
  // "code" (VS Code) or "cursor"
  "ide": "code",

  // Path to SSH private key. null = use your SSH config or ssh-agent
  "sshKeyPath": null,

  // SSH user on remote instances
  "sshUser": "root",

  // Ports to forward to localhost. Set to [] to disable
  // Local ports auto-increment when multiple instances are running
  "portForwards": [
    { "local": 8080, "remote": 8080 }
  ],

  // Remote directory where projects are cloned
  "workspace": "/workspace",

  // Creates ~/.no_auto_tmux to prevent auto-tmux on Vast images
  "disableAutoTmux": true,

  // Which git remote to read the repo URL from
  "gitRemote": "origin",

  // Commands to run after dependency install
  // e.g. ["curl -fsSL https://claude.ai/install.sh | bash"]
  "postInstall": [],

  // Override auto-detected install method. null = auto-detect
  // e.g. "uv sync", "pip install -e '.[dev]'", "conda env update -f environment.yml"
  "installCommand": null
}

Troubleshooting

"Missing: vastai CLI" -- pip install vastai, then vastai set api-key <key>.

SSH connection timeout -- Instance may still be booting. Setup retries 3 times. Run vastai show instances to check status.

"Not in a git repo" -- vst reads the remote URL from your local repo. Run from inside a git repo, or use --no-setup.

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

vastly-0.2.4.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

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

vastly-0.2.4-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file vastly-0.2.4.tar.gz.

File metadata

  • Download URL: vastly-0.2.4.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for vastly-0.2.4.tar.gz
Algorithm Hash digest
SHA256 0a5997f0f19752daa2cc2c68cd6e781934d00804f5db18c676e21b4e37ef502a
MD5 bad9c07fc0497ae4789ffb2692ba3c3e
BLAKE2b-256 f73eecfeefbf60f9f390ac55071fffd606c5fd910afe7850f2ad4436f0ed0412

See more details on using hashes here.

File details

Details for the file vastly-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: vastly-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for vastly-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4631270a1454cb12a3a094c1cacac44eb813970bdc3e88398730b09c371cb8e3
MD5 eb4a5e6c930f781c2ed11a0dd5c5153b
BLAKE2b-256 0cdfdd12b46639a65c9e18c60093d3300d2f26585fddb9321605e69ac316afd5

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