Skip to main content

Run openvscode-server anywhere with uvx

Project description

portable-ovscode

PyPI

Run openvscode-server anywhere with a single command. No pre-install needed — just uvx.

Quick Start

# SSH to your server, then:
uvx portable-ovscode

That's it. It downloads openvscode-server (if not cached), generates a token, starts the server in the current directory, and prints the URL.

Usage

uvx portable-ovscode [OPTIONS] [-- EXTRA_ARGS]
Flag Default Description
--install-dir DIR ~/.local/share/openvscode-server Where to put the binary
--version VER 1.109.5 openvscode-server version
--host ADDR 127.0.0.1 Bind address
--port PORT 3000 Bind port
--token TOKEN auto-generated Connection token
--no-token Disable auth token
--folder PATH Default folder to open
--https Enable HTTPS with auto-generated self-signed cert
--cert PATH Path to TLS certificate (implies --https)
--cert-key PATH Path to TLS private key (implies --https)
--install-only Download only, print binary path

Extra arguments after -- are passed directly to openvscode-server.

Examples

# Install + run on port 8080, open ~/work
uvx portable-ovscode --port 8080 --folder ~/work

# Custom install location
uvx portable-ovscode --install-dir /opt/ovscode --folder ~/project

# Specific version
uvx portable-ovscode --version 1.95.3 --folder ~/code

# Just install, don't start
uvx portable-ovscode --install-only

# HTTPS with self-signed cert (for LAN access)
uvx portable-ovscode --https --host 192.168.1.50 --port 443

# Bring your own cert
uvx portable-ovscode --cert /path/cert.pem --cert-key /path/key.pem --host 0.0.0.0

# With SSH tunnel (from local machine)
ssh -L 3000:127.0.0.1:3000 user@remote
# then on remote:
uvx portable-ovscode --folder ~/project
# open http://127.0.0.1:3000/?tkn=<printed-token> locally

Agentic Programming

Works great with AI coding agents like Claude Code, Codex, or pi-agent. Let the agent edit your code, then spin up an editor to review the changes:

# Agent makes changes in ~/project...
# Review them instantly:
uvx portable-ovscode --folder ~/project

No IDE needs to be pre-installed — just open the URL, review diffs, and you're done.

How It Works

  1. Detects platform architecture (x64/arm64).
  2. Downloads the release tarball from GitHub (cached in --install-dir).
  3. Generates a random connection token.
  4. Starts openvscode-server bound to loopback by default.
  5. Prints the URL with token to stderr.

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

portable_ovscode-0.3.0.tar.gz (16.1 kB view details)

Uploaded Source

Built Distribution

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

portable_ovscode-0.3.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file portable_ovscode-0.3.0.tar.gz.

File metadata

  • Download URL: portable_ovscode-0.3.0.tar.gz
  • Upload date:
  • Size: 16.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for portable_ovscode-0.3.0.tar.gz
Algorithm Hash digest
SHA256 31baa792109fdd11ad615e671ca874199a275c20548bb110afca828001706be9
MD5 74c27ceb653e2fa94a6fa95be261aedd
BLAKE2b-256 749b0fce49e8d81ed5b25d5fad04005955dcc5023fc058d1b18109e49d4a7f0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for portable_ovscode-0.3.0.tar.gz:

Publisher: publish.yml on iamwrm/portable_ovscode

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file portable_ovscode-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for portable_ovscode-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 044406346e3d1d5847d42ce688ec038f8ca079dd2180395797e2a2bf478cd942
MD5 6ac323a06725fae4639d18ab97ffb8e6
BLAKE2b-256 0a2c35fba3992f17304a88c51c6c9bed821773c84c493602f22d2d8f59f85b4e

See more details on using hashes here.

Provenance

The following attestation bundles were made for portable_ovscode-0.3.0-py3-none-any.whl:

Publisher: publish.yml on iamwrm/portable_ovscode

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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