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.8.tar.gz (5.9 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.8-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vs_server_colab-1.0.8.tar.gz
  • Upload date:
  • Size: 5.9 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.8.tar.gz
Algorithm Hash digest
SHA256 ce9b70d2be87d1904f472e7f7978673aaa471698e7c2ed18df37ea9d1b0562ca
MD5 d046d7f8682b8af889faa796e0968782
BLAKE2b-256 7b8f81d9c0c85f8c2b0a65a99b461aa560fca8a5de635aa9de541aa86bd704b9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vs_server_colab-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 ce499005ab708fd307d2f82d922a590e3824c57ef6d15df001b514b8e59fae05
MD5 61ebb7716b5ef65b9b23deb194e0abd1
BLAKE2b-256 c4e974d3b3f0408b0812ff0744478229cbf9fc707dac160f960db40c0d82b537

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