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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vs_server_colab-1.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 da40974b5c783d04b991c58b78ddfd977d4fef2c73badbe0b77af8eaccd41bfd
MD5 e26700b435cb2179928c8a38d033561d
BLAKE2b-256 d3d12c65ea8f40483c1342b89069b624dc8b5d2cae2370364459ab3dbe495b64

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vs_server_colab-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 9169aa0f1fc5f6c69cb7c2cb73bf39bbaaeb38035d379bd68c2b1e5da704e916
MD5 cb7be6b2022e033150169fa19e5e8339
BLAKE2b-256 4c1b4e4370237ff27f3bd362e02f0c8ad10efe980067f57f6fa675893be740cd

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