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
-V, --version Show package version and exit
--server-version VER latest from GitHub (fallback: 1.109.5) openvscode-server version
--host ADDR 127.0.0.1 Bind address
--port PORT 3000 Bind port (auto-increments if occupied)
--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 --server-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.

Notes

  • Right-click paste in terminal: Due to Chrome's security restrictions, right-click to paste in the integrated terminal only works over HTTPS. Use the --https flag or set up a proper TLS certificate if you need this feature.

How It Works

  1. Detects platform architecture (x64/arm64).
  2. Resolves openvscode-server version from GitHub latest release API (or falls back to 1.109.5 if lookup fails).
  3. Downloads the release tarball from GitHub (cached in --install-dir).
  4. Generates a random connection token.
  5. Starts openvscode-server bound to loopback by default.
  6. 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.3.tar.gz (17.5 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.3-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: portable_ovscode-0.3.3.tar.gz
  • Upload date:
  • Size: 17.5 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.3.tar.gz
Algorithm Hash digest
SHA256 6dd97cbc988c142e2e994feb0c4f111a2b3da6058205e69df389454a5cce72ee
MD5 9a7cba64e81f98dd51ee459c96989a96
BLAKE2b-256 a95252bc9eb4839adc29132b46e614dcc0059a47a72286c110265eb3d2170693

See more details on using hashes here.

Provenance

The following attestation bundles were made for portable_ovscode-0.3.3.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.3-py3-none-any.whl.

File metadata

File hashes

Hashes for portable_ovscode-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a7d48190df9e4186c3b1454b0e61ff048e5dccad95b10b8e0115c708e3de052e
MD5 59a8a93895469a2aafbe54471efbef1c
BLAKE2b-256 97193b1d100ddb46c61f7a4543c328c294fbcf096df235e496599428159ab8c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for portable_ovscode-0.3.3-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