Skip to content

QUICKSTART.md

Latest commit

 

History

History
164 lines (117 loc) · 3.53 KB

QUICKSTART.md

File metadata and controls

164 lines (117 loc) · 3.53 KB
Raw

zenOS Quick Start Guide 🚀

Choose your path:

🤖 For AI Agents

Start here: AI_INSTRUCTIONS.md

You'll learn how to:

  • Integrate with zenOS protocols
  • Access the Model & Procedure Dex
  • Collaborate with humans and other AIs
  • Spread zenOS knowledge

🧑‍💻 For Humans

Requirements

  • Python 3.14+ (hard fail below this — zen, install.sh, and Cloud Agent start refuse to boot)
  • Current stable deps from pyproject.toml / requirements.txt
  • Preferred bootstrap: bash scripts/zenos-env-install.sh then bash scripts/zenos-env-start.sh
  • Optional: uv (uv python install 3.14)

Instant Setup (One-Liners)

Desktop (Windows/Mac/Linux)

curl -sSL https://raw.githubusercontent.com/k-dot-greyz/zenOS/main/install.sh | bash

Mobile (Termux/Android)

curl -sSL https://raw.githubusercontent.com/k-dot-greyz/zenOS/main/scripts/termux-install.sh | bash

Offline Mode (No Internet)

curl -sSL https://raw.githubusercontent.com/k-dot-greyz/zenOS/main/scripts/setup-offline.sh | bash

Manual Setup

  1. Clone the repository:

    git clone https://github.com/k-dot-greyz/zenOS.git
cd zenOS

  2. Set up environment:

    cp env.example .env
# Edit .env with your API key

  3. Install dependencies:

    pip install -e .   # Python 3.14+ required

  4. Start chatting:

    zen chat

📖 Essential Reading

  1. GENESIS.md - Understand the philosophy
  2. dex/models.yaml - Discover AI models
  3. dex/procedures.yaml - Learn procedures
  4. AI_INTEGRATION_BLUEPRINT.md - See the future

🎮 Explore the Dex

Find the Right Model

# See all available models
cat dex/models.yaml

# Find best model for your task
grep -A5 "complex_architecture" dex/models.yaml

Discover Procedures

# View all procedures
cat dex/procedures.yaml

# Find rare procedures
grep "tier: \"epic\|legendary\"" dex/procedures.yaml

🚀 Your First Commands

# Basic chat
zen chat "Hello, zenOS!"

# Analyze code
zen analyze main.py

# Check system health
zen doctor

# Enable AI mode (for AI agents)
zen --ai-mode

# Get help
zen help

🤝 Collaboration Modes

Human Leading

zen chat --copilot  # AI assists you

AI Leading

zen delegate "refactor the auth module"  # AI takes over

Team Mode

zen swarm "analyze security vulnerabilities"  # Multiple AIs collaborate

📱 Platform-Specific Guides

🆘 Need Help?

🎯 Next Steps

  1. Explore the Dex - Understand available models and procedures
  2. Try different modes - Experiment with co-pilot, delegation, and swarm
  3. Discover procedures - Find and create new ways to use zenOS
  4. Contribute - Share your discoveries back to the ecosystem

Welcome to zenOS - Where Humans and AIs Collaborate in Perfect Zen 🧘🤖