Skip to main content

Web-based terminal accessible from phone via Cloudflare Tunnel

Project description

Porterminal - Vibe Code From Anywhere

PyPI Python Downloads License

1. uvx ptn
2. Scan the QR
3. Access your terminal from your phone


Why

I wanted to vibe code from bed. ngrok requires registration and the free tier sucks. Cloudflare Quick Tunnel works great but is hard to use directly on the phone. Termius works after complicated setup: port forwarding, firewall rules, key management... I just wanted something simpler: run a command, scan a QR, start typing.

Features

  • One command, instant access - No SSH, no port forwarding, no config files. Cloudflare tunnel + QR code.
  • Actually usable on mobile - + Essential buttons and gestures for everyday terminals use for vibe coding and mroe.
  • Multi-tab shared sessions - Run builds in one tab, tail logs in another. Sessions persist across reconnects.
  • Cross-platform - Windows (PowerShell, CMD, WSL), Linux/macOS (Bash, Zsh, Fish). Auto-detects your shells.

Install

Method Install Update
uvx (no install) uvx ptn uvx --refresh ptn
uv tool uv tool install ptn uv tool upgrade ptn
pipx pipx install ptn pipx upgrade ptn
pip pip install ptn pip install -U ptn

Requires Python 3.12+ and cloudflared (auto-installed if missing).

Usage

ptn                    # Start in current directory
ptn ~/projects/myapp   # Start in specific folder
ptn --no-tunnel        # Local network only
ptn -b                 # Run in background
ptn -v                 # Verbose logs

Configuration

Create ptn.yaml in your working directory, .ptn/ptn.yaml, or ~/.ptn/ptn.yaml (optional):

terminal:
  default_shell: bash
  cols: 120
  rows: 30

buttons:
  - label: "git"
    send: "git status\r"
  - label: "build"
    send: "npm run build\r"

Security

Warning: The URL is the only authentication. Anyone with the link has full terminal access.

  • Don't share the URL
  • Stop the server when not in use (Ctrl+C)
  • Use --no-tunnel for local network only
  • Environment variables are sanitized (API keys, tokens stripped)

Contributing

Issues and PRs welcome.

git clone https://github.com/lyehe/porterminal
cd porterminal
uv sync
uv run ptn

License

AGPL-3.0

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

ptn-0.2.0.tar.gz (723.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ptn-0.2.0-py3-none-any.whl (760.4 kB view details)

Uploaded Python 3

File details

Details for the file ptn-0.2.0.tar.gz.

File metadata

  • Download URL: ptn-0.2.0.tar.gz
  • Upload date:
  • Size: 723.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ptn-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a69123af185263ebd8df31e9e5eef42f36705bc814b02bcc11ffa766918e03a4
MD5 c2ff437838b96eab2978973abfe49981
BLAKE2b-256 a7806c4126110a336c3c771612e6f30abb7157a36cee92af99941dcdcfd60354

See more details on using hashes here.

Provenance

The following attestation bundles were made for ptn-0.2.0.tar.gz:

Publisher: publish.yml on lyehe/porterminal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ptn-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: ptn-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 760.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ptn-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d642ff4a536ed87ea46729dd83ddd98ce6cd5567b0afa62c8277ef94e1d7a2ab
MD5 9c880271c215a78947c88708913c3d33
BLAKE2b-256 3346e985d2e8c1906d0e1e3ccf5d8194cde92d4816fba3c4fbbe110b59de85f5

See more details on using hashes here.

Provenance

The following attestation bundles were made for ptn-0.2.0-py3-none-any.whl:

Publisher: publish.yml on lyehe/porterminal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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