PinkCollab

PinkCollab, Android client for Oh My Pi (OMP).

OMP runs on your computer or server. Use the PinkCollab mobile app to start sessions and steer their progress.

Install

Install the app and Gateway from the same release.

1. Host: Node.js 18+. Install Tailscale and allow Funnel for this node.
2. Phone: install the release APK.

npm install -g pinkcollab@latest

Use

1. Set up the host once. Make sure omp --version works, then choose an existing directory for your projects:

   pinkcollab init --workspace /absolute/path/to/projects
   pinkcollab funnel

   On Windows, use a path such as C:/code. To allow more than one directory, repeat --workspace in the same init command. funnel sets up the public HTTPS address used by the phone.

2. Start the Gateway. Run this on the host and leave the terminal open while using the app:

   pinkcollab serve

3. Pair your phone. Open another terminal on the host and run:

   pinkcollab pair

   Scan the QR code in the PinkCollab app. The code can be used once within five minutes. Run pinkcollab pair again if it expires.

4. Start a session. In the app, open Workspaces, choose a directory, create a session, and send a prompt. Use Stop to interrupt the current turn, Exit to end the runtime after confirmation, and Send to submit a prompt.

For later use, start the Gateway with pinkcollab serve and open the app on your paired phone. To change the allowed directories, edit workspaces in ~/.pinkcollab/config.yaml. init will not overwrite an existing configuration.

For Funnel permissions, connection troubleshooting, or running the Gateway in the background, see Deployment and networking.

How it works

flowchart TD
    subgraph phone [Phone]
        App[Android app]
    end
    subgraph host [Your computer / Server]
        direction LR
        Funnel[Tailscale Funnel]
        Gateway
        OMP[OMP process]
        Funnel -->|loopback HTTP| Gateway
        Gateway -->|NDJSON| OMP
    end
    Provider[Model provider]
    App -->|HTTPS / WSS| host
    host -->|provider API| Provider

Loading

Docs

• Architecture: components, lifecycles, and state ownership
• Protocol v2: REST and WebSocket API contracts
• Deployment and networking: HTTPS access, pairing, background services, and Gateway CLI/configuration
• Development: contributor setup, builds, and validation
• Releases: maintainer guide to signing and publishing Android, Gateway, and npm releases

License

MIT