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.3.tar.gz (5.3 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.3-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vs_server_colab-1.0.3.tar.gz
  • Upload date:
  • Size: 5.3 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.3.tar.gz
Algorithm Hash digest
SHA256 64760fef210f5f35cf0493807898c54277b8df06500a994e1be10cb71d2ce709
MD5 8cd4b9944ea1ddb87fa51630746559db
BLAKE2b-256 ff26fcea54f6ec7e68898b177d4b3202aa2b92373eb2fe7b6d419c9c69c1d706

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vs_server_colab-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 aa66f7dbdc26da0451d253151cde123168d9fd2cfd218db8aaf5412d952dc586
MD5 9beee398ca6261d354c4baac480520a6
BLAKE2b-256 2fa5eeba39e24badea08e23517c6b992e6e1acffbe54873ee4512a3d750484ff

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