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.1.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.1-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vs_server_colab-1.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 cbac6cb3fcb6178ba7859a6e696b40e3388ef55baa93d1e6d34c9902a8260c82
MD5 93435ce65572104a23327231e5f4ae3f
BLAKE2b-256 28b2ea89609214b5e67c060efd1db5b57d785553981a55b30b495e514e5a4061

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vs_server_colab-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5516a417780256d9c89fc4f9432bf9a7b0ddd5f213cb38ba48a9fb179e4b07dc
MD5 d5230b34469ffafafd3a3151cd74453d
BLAKE2b-256 e8fed2748e9b72bc2dbe572fa2b0219b50660d4fc59026c1dd034904b312963e

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