---
title: Shellular Web UI
emoji: 🖥️
colorFrom: blue
colorTo: indigo
sdk: docker
pinned: false
---

# Shellular Web UI

A minimal web interface that runs **[Shellular](https://shellular.dev)** on this Space and displays the pairing QR code so you can connect your phone without needing terminal access.

## How it works

1. The app is protected by a secret key you set in **Settings → Repository secrets** as `SECRET_KEY`.
2. Open the Space URL, enter your key, and click **Login**.
3. Shellular starts automatically and the QR code is shown on screen.
4. Scan it with the **Shellular app** ([iOS / Android](https://shellular.dev)) to connect.

## Setup

### 1. Fork / duplicate this Space

### 2. Add your secret

Go to **Settings → Variables and secrets** and add:

| Name | Value |
|------|-------|
| `SECRET_KEY` | any strong password of your choice |

### 3. That's it

The Space will build and start. Open it, enter your key, and scan the QR code.

## Notes

- Only **one** Shellular instance can run per container. If you restart the Space the QR code changes (new host key). The connected phone will need to re-scan.
- The QR code uses Unicode block characters. If your phone struggles to scan it, try zooming in slightly or reducing screen brightness.
- All Shellular traffic is **end-to-end encrypted** with libsodium.