zolo-os 1.6.7

Zolo Operating System - A full-stack application framework with declarative configuration, layered architecture, and rich subsystems

zOS

Pre-Alpha — v1.5.8 zOS is ~90% stable and actively used in production internally. The API is functional and the architecture is settled, but rough edges remain. The Documentation/ guides are technically accurate against the core design; some details may lag behind the latest source. Live, up-to-date docs are coming with the official alpha release via zCloud (zolo.media). Use at your own risk and expect breaking changes before v2.0.

---

Declare once—run everywhere.

zOS is not just a Command Line Interface, but a Context Layer Interface—a declarative cross-platform Python framework where context flows through layers to determine how your application manifests.

Write once, adapt to any context: user role, deployment environment, device, or runtime mode (Terminal or Web). zOS handles the heavy lifting, turning ideas into working tools faster.

---

Quick Start

# Install from this repo (PyPI release not yet available)
pip install git+https://github.com/ZoloAi/zOS.git

# Or clone and install locally
git clone https://github.com/ZoloAi/zOS.git
pip install ./zOS

# Start an app
z zApp

⚠️ PyPI warning: A public zolo package exists on PyPI that is unrelated to this project and will cause conflicts. Install from this repo only.

---

📚 New to Zolo?

Start with The zPhilosophy.
It introduces the core concepts of zOS and smoothly leads into the layer-by-layer guides with ready-made demos.

Requirements

• Python 3.9+

Need help installing requirements on Windows or macOS?
See zInstall Guide for detailed instructions.

---

Installation Options

All installs are from this repo until the official alpha PyPI release.

Variant	Use Case	Install Command
Basic	SQLite only	pip install git+https://github.com/ZoloAi/zOS.git
CSV	+ CSV/Pandas	pip install "zOS[csv] @ git+https://github.com/ZoloAi/zOS.git"
PostgreSQL	+ PostgreSQL	pip install "zOS[postgresql] @ git+https://github.com/ZoloAi/zOS.git"
Full	All backends	pip install "zOS[all] @ git+https://github.com/ZoloAi/zOS.git"

See zInstall Guide for editable install and troubleshooting.

---

🏗️ Architecture

zOS v1.5+ (Context Layer Interface) follows a 5-layer architecture inspired by "Linux From Scratch"—each subsystem stands alone, tested independently, then composed into higher abstractions.

Layer 0: /zSys/             — Pre-boot utilities: formatting, errors, install, logging, CLI routing
Layer 1: /L1_Foundation/    — zConfig (config hierarchy + secrets) + zComm (HTTP, WebSocket, services)
Layer 2: /L2_Handling/      — Display, Auth, Dispatch, Navigation, Parser, Loader (+ plugins), Func, Dialog, Open
Layer 3: /L3_Abstraction/   — zWizard (workflows), zData, zBifrost (WS bridge), zShell (REPL)
Layer 4: /L4_Orchestration/ — zWalker (declarative UI orchestrator) + zServer (HTTP/WSGI server)

Subsystems by Layer

Subsystem	Purpose
	Layer 1 — /L1_Foundation/
zConfig	Self-aware config layer — machine → environment → session hierarchy with secrets + logging
zComm	Communication hub — HTTP client, service orchestration (PostgreSQL, Redis), network utilities
	Layer 2 — /L2_Handling/
zDisplay	Render everywhere — 30+ events (tables, forms, widgets) adapt to Terminal or GUI automatically
zAuth	Three-tier auth system — bcrypt + RBAC + git-like identity, manage platform + multi-app users simultaneously
zDispatch	Universal command router — simple modifiers (^~*!) shape behavior, routes to 7+ subsystems seamlessly
zNavigation	Unified navigation — menus + breadcrumbs + state + inter-file links, all RBAC-aware
zParser	Declarative paths & parsing — workspace-relative + user dirs + plugin discovery, 21+ unified methods
zLoader	Intelligent file loader — 4-tier cache system (System + Pinned + Schema + Plugin) with mtime tracking
zFunc	Dynamic Python executor — cross-language (using zBifrost) + internal Python, auto-injection removes boilerplate
zDialog	Declarative form engine — define once, auto-validate, render everywhere (Terminal or GUI)
zOpen	Universal opener — cross-OS routing (URLs, files, zPaths) for your tools (session-aware browser + IDE preferences)
	Layer 3 — /L3_Abstraction/
zUtils	REMOVED v1.7.0 — Plugin management migrated to zLoader (Layer 1) - see migration guide
zWizard	Multi-step orchestrator — sequential execution + zHat result passing, enabling workflows and navigation
zData	Database abstraction — backend-agnostic declarations (SQLite ↔ PostgreSQL ↔ CSV), and auto migration
zBifrost	WebSocket bridge — real-time bidirectional communication (server + JavaScript client), enables Terminal → Web GUI transformation
zShell	Interactive command center — 18+ commands + wizard canvas, persistent history, direct access to all subsystems
	Layer 4 — /L4_Orchestration/
zWalker	Declarative UI orchestrator — menus + breadcrumb navigation, coordinates the lower-layer subsystems, Terminal and GUI
zServer	HTTP/WSGI server — serves HTML/CSS/JS + declarative routing, dev mode (lightweight) and production mode (Gunicorn), pairs with zBifrost
zRaven	Automated test subsystem — drives zWalker + zServer + zBifrost end-to-end; zSpark-activated, off by default
	L4 overview →

🔒 Security & secrets

zOS treats environment files like dotenv: zEnv.base.zolo and zEnv.<env>.zolo are parsed and injected into os.environ at boot — they are never served over HTTP. The built-in zServer SecurityChecker returns 403 for:

• env/config/manifest files (/zEnv.*, /zConfig.*, /zSpark.*, /certs/, …)
• any hidden path segment (/.git/, /.env, …) — even nested under a mount
• source/secret file types served as assets (.py, .zolo, .key, .pem, .db, …)

So a /plugins/ mount serves your client .js, but never the server-side .py.

Production checklist

• Keep zEnv.* and certs/*.key|pem|cert gitignored — never commit real secrets.
• Inject prod secrets via the platform (IAM role / secrets manager), not files.
• Set TLS certs in zEnv.production → HTTPS/WSS auto-enable (TLS 1.2+).
• Set the public WEBSOCKET_HOST/port and WEBSOCKET_ALLOWED_ORIGINS.

Alpha note: WebSocket origin/CSRF validation is enabled together with WEBSOCKET_REQUIRE_AUTH (per-feature toggles land before v2.0), and the shared WS token uses a direct compare. Hardening continues through the alpha.

---

Uninstall & cleanup

Run this command in your terminal:

zolo uninstall

This launches an interactive menu where you can choose:

1. Framework Only (default) - Removes the package, keeps your data and optional dependencies
2. Clean Uninstall - Removes package AND all user data (configs, databases, cache)
3. Dependencies Only - Removes optional dependencies (pandas, psycopg2) but keeps zOS

Each option shows you exactly what will be removed and asks for confirmation before proceeding.

More details →

License

MIT License with Ethical Use Clause

Copyright (c) 2024 Gal Nachshon

Trademarks: "Zolo" and "zOS" (Context Layer Interface) are trademarks of Gal Nachshon.

See LICENSE for details.

---

Documentation

The guides below are technically accurate against the core architecture, but some details may be slightly behind the current source. Live docs with full examples will ship with the official alpha at zolo.media.

• zPhilosophy - Core concepts and design principles
• Installation Guide - Setup instructions
• AI Agent Guide - Reference for AI coding assistants
• Subsystem Guides - Guides for all 20+ subsystems

---

Next: The zPhilosophy →