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

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.2.0.tar.gz (6.3 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.2.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: portable_ovscode-0.2.0.tar.gz
  • Upload date:
  • Size: 6.3 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.2.0.tar.gz
Algorithm Hash digest
SHA256 09299b9245b47b333275b31466046932c4b238ff3558964e23a4410c9633e292
MD5 f8146492e0551a8b594ad08d857b6626
BLAKE2b-256 529c49f09da543fcc90b08f3e6cb622a699843b71d0df57957e86397f5a70bed

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for portable_ovscode-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ede9a2124512c8e207f0a6b118abe2c0537349ca737d66521b3ee00f1d01fd57
MD5 228ee0097d1e1ea87f4e8589fd5d1ccc
BLAKE2b-256 5767d53b27a23eadf5ff99a1c9225878ea54c75c8c06c1dc819eebc4f4959aee

See more details on using hashes here.

Provenance

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