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.4.tar.gz (5.4 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.4-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vs_server_colab-1.0.4.tar.gz
  • Upload date:
  • Size: 5.4 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.4.tar.gz
Algorithm Hash digest
SHA256 d1d3f66041061b4fb0847f51f6f236cedec1e4c6347e86530a67849fc787d589
MD5 1f2b1815660e04829481d3167da35257
BLAKE2b-256 b9c9f9c7956de9f6188396bbd385d376ea45a6cca0ae135b0e0abae2ab822d36

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vs_server_colab-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5a3c7bff16275d6af4a3595deb1de7b7fb8284648b1e48fdb45393d6e81bae10
MD5 bf5f0794b8c13445d822333e3a1be625
BLAKE2b-256 554f98645f2d7ac0d6cb9ae5fd2fa0630b68f76f8d13d96dd96f4eae70201277

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