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.5.tar.gz (5.6 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.5-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vs_server_colab-1.0.5.tar.gz
  • Upload date:
  • Size: 5.6 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.5.tar.gz
Algorithm Hash digest
SHA256 d70d2d51cd4efe5e8445595d54d22aa0ef78484fbe3f5037456fe4d463721273
MD5 9647ee602e7683d3b25c623a252c8908
BLAKE2b-256 b23224d5a0c36f3ec7e8b466f69f9f90b2c81325b38cf04a6b73fe3386b6687c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vs_server_colab-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 635635a1335a8b5cedde0850a2679ffdef532c6c5e6eba5eeba941ca545d53b1
MD5 aff48096668767f4c0a5fc7681b76ee6
BLAKE2b-256 8a24e7c25afc7ed93702d3612c66537dee46bbe50c10e3dffdd863ca198f0c54

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