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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vs_server_colab-1.0.7.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.7.tar.gz
Algorithm Hash digest
SHA256 df7250b010ebff2f0eaafabfec7aed9cbd962f73a775b60e3f06fc06a8b55cdc
MD5 693dd8d08bbac3d82d76f6e4706247b6
BLAKE2b-256 83dc1a3c02143ea32e385b8a66cd15e29019535ad9e31fa44535d511d43f794b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vs_server_colab-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 450aa750a83a8558a6acf2b62bf8d818f544369200dae99e2c303414e766076d
MD5 8c09f8ef4efaeb4f5f334bbb3b01f7d8
BLAKE2b-256 bdb80087519e42016879c05a8d2845465992a609f7845c918ab92f170e0cc0ec

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