README.md

Personal Artificial Intelligence Operating System (pAI-OS)

Getting Started

Users

An easy to use release is coming soon, but for now you can follow the instructions below to get started.

Early Adopters

💡 Tip: Download and install Python if you can't run it from the terminal.

Open the Terminal application.

Clone the canary branch from the repository:

git clone --branch canary --single-branch https://github.com/pAI-OS/paios.git

Setup and run the server:

Alembic

Alembic is used to manage database versioning using migrations.

Upgrade schema

alembic upgrade head

Downgrade schema

alembic downgrade -1

Update schema

Update backend/models.py then run:

alembic revision --autogenerate -m "added asset table"

** NOTE: If you get an error about an already existing table, you may want to drop the table and run 'alembic upgrade head' again. **

POSIX (Linux/macOS/etc.)

python3 paios/scripts/setup_environment.py (only on first run)
source paios/.venv/bin/activate
python3 -m paios

Windows

python .\paios\scripts\setup_environment.py (only on first run)
.\paios\.venv\Scripts\Activate.ps1
python -m paios

Visit https://localhost:8443/

Developers

Clone the entire repository

git clone https://github.com/pAI-OS/paios.git

🤖 Tip: Early Adopters don't need to build the frontend on the canary branch because it's done automatically on every commit to main.

Build the frontend:

cd frontend
npm run build
cd ..

Run the uvicorn server:

python -m paios

Visit https://localhost:8443/