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.9.tar.gz (5.7 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.9-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vs_server_colab-1.0.9.tar.gz
  • Upload date:
  • Size: 5.7 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.9.tar.gz
Algorithm Hash digest
SHA256 db2d9e565256f614e6c66229fd7857248fd868e241601c46d719095c09e77562
MD5 ecbf14814ae418c096fb9e0bf1c79c79
BLAKE2b-256 6415bc5a4b3cdb1d4f3786aee407bbedbc63af25afb181a4425f3258fa0a7167

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for vs_server_colab-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e144fefbbc7642c6f9baec4e57a04e56a60698dfdbd5151515157f179da80ed3
MD5 6b65ee624323ada84cd89d14af1568e3
BLAKE2b-256 5f7879db5f3de5d9f845c3830d0e4364443fd0de3e8ff7db5d00a3583e2ad056

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