diff --git a/README.md b/README.md index 8595f4a..35bf948 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,8 @@ A locally-hosted operating system for AI agents โ€” an open-source GitHub reposi ## ๐Ÿš€ Quick Start +### Linux/macOS + ```bash git clone https://github.com/modimihir07/agentic-os.git cd agentic-os @@ -99,6 +101,16 @@ chmod +x install.sh && ./install.sh # Open http://127.0.0.1:8080 ``` +### Windows PowerShell + +```powershell +git clone https://github.com/modimihir07/agentic-os.git +cd agentic-os +.\install.ps1 +.\start.ps1 +# Open http://127.0.0.1:8080 +``` + --- ## ๐Ÿ“‹ Prerequisites @@ -107,12 +119,14 @@ chmod +x install.sh && ./install.sh | Tool | Required? | Install | |------|-----------|---------| -| Python 3.10+ | โœ… Required | Linux/macOS: install from your package manager or `python.org`. Windows: install from `python.org` and select **Add Python to PATH**. Verify with `python --version` or `py -3 --version`. | -| Node.js 18+ | โš  For opencode | `curl -fsSL https://deb.nodesource.com/setup_20.x \| sudo bash - && sudo apt install -y nodejs` | +| Python 3.10+ | โœ… Required | Install from your package manager or [python.org](https://www.python.org/downloads/). Verify with `python3 --version`. | +| Node.js 18+ | โš  For opencode and Gemini CLI | `curl -fsSL https://deb.nodesource.com/setup_20.x \| sudo bash - && sudo apt install -y nodejs` | | opencode | โš  For code tasks | `npm install -g @opencode/cli` | -| Hermes Agent | โš  For memory/scheduling | `curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh \| bash` | +| Hermes Agent | โš  For memory/scheduling | Follow the upstream Hermes Agent documentation. If native Windows support is unavailable, use WSL for Hermes. | | Gemini CLI | โš  For Google AI | `npm install -g @google/gemini-cli` | +> โš  = Optional โ€” the dashboard starts and core pages work without all agent CLIs installed. Agent-specific chat, routing, health, and skill execution features will show offline or warning status until the relevant CLI is installed and authenticated. + ### Windows | Tool | Required? | Install | Verify / Next Step | @@ -125,16 +139,6 @@ chmod +x install.sh && ./install.sh > โš  = Optional โ€” the dashboard works with any subset of installed agents. -### Windows Quick Start - -```powershell -git clone https://github.com/modimihir07/agentic-os.git -cd agentic-os -.\install.ps1 -.\start.ps1 -# Open http://127.0.0.1:8080 -``` - The PowerShell launchers resolve Python in this order: `py -3.10`, `py -3`, then `python`. For manual commands, prefer `python -m pip install -r requirements.txt` and `python server.py --port 8080` so the same interpreter runs both dependency installation and the server. > **PowerShell execution policy:** if you use PowerShell scripts, allow local scripts for your user with `Set-ExecutionPolicy -Scope CurrentUser RemoteSigned`, or run a single installer invocation with `powershell -ExecutionPolicy Bypass -File .\install.ps1`. @@ -172,7 +176,7 @@ Edit `data/settings.json`: agentic-os/ โ”œโ”€โ”€ server.py # FastAPI backend (REST API) โ”œโ”€โ”€ requirements.txt # Python dependencies -โ”œโ”€โ”€ install.sh # One-command installer +โ”œโ”€โ”€ install.sh / install.ps1 # Platform installers โ”œโ”€โ”€ start.sh # Launch dashboard โ”œโ”€โ”€ backup.sh / restore.sh # Disaster recovery โ”‚ @@ -330,7 +334,7 @@ Browse opencode session logs by date and size. Click "Replay" to view all messag ## ๐Ÿงช Tested On -- **OS**: Linux (Ubuntu 22.04+), macOS +- **OS**: Linux (Ubuntu 22.04+), macOS; Windows dashboard setup supported via PowerShell, with Hermes best used through WSL if native support is unavailable - **Python**: 3.10, 3.11, 3.12 - **Browsers**: Chrome, Firefox, Edge - **Agents**: opencode v0.8+, Hermes Agent v1.0+, Gemini CLI v1.0+ diff --git a/install.ps1 b/install.ps1 index a9bab85..6379aee 100644 --- a/install.ps1 +++ b/install.ps1 @@ -22,7 +22,7 @@ function Resolve-Python { } } - throw "Python 3.10+ is required. Install it from https://www.python.org/downloads/ and check 'Add Python to PATH'." + throw "Python 3.10+ is required. Install it from https://www.python.org/downloads/ (check 'Add Python to PATH') or run: winget install Python.Python.3.12" } $python = Resolve-Python @@ -34,11 +34,11 @@ Write-Host "Python: $pythonVersion" Write-Host "Installing Python dependencies..." & $pythonCommand @pythonArgs -m pip install -r requirements.txt --quiet -# Check Node.js (for opencode) +# Check Node.js (for opencode and Gemini CLI) if (Get-Command node -ErrorAction SilentlyContinue) { Write-Host "Node.js: $(node --version)" } else { - Write-Warning "Node.js not found. opencode requires Node 18+. Install from https://nodejs.org/." + Write-Warning "Node.js not found. opencode and Gemini CLI require Node 18+. Install from https://nodejs.org/ or run: winget install OpenJS.NodeJS.LTS" } # Check opencode @@ -53,7 +53,7 @@ if (Get-Command opencode -ErrorAction SilentlyContinue) { if (Get-Command hermes -ErrorAction SilentlyContinue) { Write-Host "Hermes: found" } else { - Write-Warning "Hermes Agent not found. See the Hermes Agent documentation for Windows installation guidance." + Write-Warning "Hermes Agent not found. Native Windows support is not confirmed by this project - check the upstream Hermes Agent documentation, and use WSL if no native installer is available." } # Check Gemini CLI @@ -100,3 +100,8 @@ Write-Host " 1. Edit data/settings.json with your API keys" Write-Host " 2. Double-click the 'Agentic OS Dashboard' shortcut on your Desktop" Write-Host " (or run .\start.ps1 / .\Launch-Dashboard.bat manually)" Write-Host " 3. Your browser will open automatically once the server is ready" +Write-Host "" +Write-Host "Optional agent CLI reminders:" +Write-Host " opencode: npm install -g @opencode/cli" +Write-Host " Gemini: npm install -g @google/gemini-cli" +Write-Host " Hermes: Use upstream docs for native Windows support, or WSL if native support is unavailable." diff --git a/server.py b/server.py index 7fa6240..6d9c6bb 100644 --- a/server.py +++ b/server.py @@ -1661,7 +1661,7 @@ def index(): content = content.replace('src="app.js"', 'src="/dashboard/app.js"') content = content.replace('pages/', '/dashboard/pages/') return HTMLResponse(content=content) - return HTMLResponse("

Agentic OS

Dashboard not built yet. Run ./install.sh first.

") + return HTMLResponse("

Agentic OS

Dashboard not built yet. Run the installer for your platform first (./install.sh on Linux/macOS or .\\install.ps1 on Windows).

") # โ”€โ”€โ”€ Favicon โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€