Skip to main content

Expose a code-server instance over ngrok

Project description

VS Server Colab

Small utility to install and run a headless VS Code (code-server) and expose it via ngrok.

Features

  • Install scripts (from src/) for code-server and ngrok (invoked by setup).
  • Start code-server and ngrok together with logs written to files.
  • Teardown/uninstall helpers.
  • Packaging with a console entry point vscolab.

Install locally

Create a virtualenv and install:

python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Usage

# setup (runs install scripts under src/)
vscolab setup

# start (will choose a random free port and start code-server + ngrok)
vscolab start --auth-token YOUR_NGROK_TOKEN

# teardown
vscolab teardown

Notes

  • This project assumes code-server and ngrok are available or that the install scripts in src/ will install them.
  • Background processes write logs to vscolab.log and ngrok.log by default.

License

MIT

vs-server-script

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

vs_server_colab-1.0.2.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

vs_server_colab-1.0.2-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file vs_server_colab-1.0.2.tar.gz.

File metadata

  • Download URL: vs_server_colab-1.0.2.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for vs_server_colab-1.0.2.tar.gz
Algorithm Hash digest
SHA256 17f2613309b2290ef1f5a5a4d1b4c3125d9b235e1b1d73806d36b8961c6f7277
MD5 4ff5ecc2b9a92e030e818963e8a0b6c9
BLAKE2b-256 123f664308c3f44afb542cfc35aff1cc10ef93cf46c1f942053f45fd40b6194c

See more details on using hashes here.

File details

Details for the file vs_server_colab-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for vs_server_colab-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 058f0970e351af7e02a098662786e2026763df24ffd15f57feab9aaa74ca134c
MD5 0b01fdc5a501529f431025c9d830b38c
BLAKE2b-256 d4bf7de63bfb95df28e1c3811e7908f337d4e00374398f049045205f3de01164

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