Get Started in 5 Minutes

Install, run, and explore

TerminalOS is designed to launch quickly and reload modules automatically. Follow these steps to get up and running.

# Clone
git clone https://github.com/NatBuilds/TerminalOS.git
cd TerminalOS

# Virtual environment
python -m venv .venv
.\.venv\Scripts\Activate.ps1

# Dependencies
pip install -r requirements.txt

# Run
python run.py

If you see the menu, the app is ready.

Your First Module

Auto-discovered on next menu render
from app.core import status

def greet() -> None:
    status.success("Hello, World!")

def register(menu) -> None:
    menu.add("Say Hello", greet)

Create app/modules/helloworld/controller.py, save it, and select the module in TerminalOS. No restart required.

Optional Android ADB Setup

For device automation

Troubleshooting

Common fixes