release(v2.0.0): cross-platform release — Linux/macOS/Windows/WSL
Creates full release package with: - release/install.sh (universal cross-platform installer) - release/windows/install.bat (Git Bash/MSYS2) - release/windows/install.ps1 (PowerShell) - release/homebrew/gyandoot.rb (Homebrew formula) - release/archives/ prebuilt binary archives - release/README.md (platform-specific install guide) - install.sh updated with same cross-platform logic - README.md updated
This commit is contained in:
189
README.md
189
README.md
@@ -1,30 +1,179 @@
|
||||
# GyanDoot v2.0 — AI Agent Platform
|
||||
# 🚀 GyanDoot v2.0 — AI Agent Platform
|
||||
|
||||
A next-generation AI Agent Platform rewritten in Rust for performance, safety, and extensibility.
|
||||
> **GyanDoot (ज्ञानदूत)** — *"Knowledge Messenger"* — your AI agent that searches, browses, and executes tasks autonomously.
|
||||
|
||||
## Architecture
|
||||
---
|
||||
|
||||
```
|
||||
gyandoot-core — Shared types, config, error types
|
||||
gyandoot-agent — Core agent loop, tool execution, context compression
|
||||
gyandoot-providers — LLM provider abstraction (OpenAI, Anthropic, Ollama)
|
||||
gyandoot-memory — MemPalace persistent memory system
|
||||
gyandoot-platform — Platform adapters (Telegram, Discord, Webhook, CLI)
|
||||
gyandoot-security — Credential vault, encryption, threat detection
|
||||
gyandoot-kanban — Kanban task system (decomposition, swarm, diagnostics)
|
||||
gyandoot-subagents — Sub-agent spawning and orchestration
|
||||
gyandoot-skills — Skills system (discovery, loading, preprocessing, bundles)
|
||||
gyandoot-profile — Multi-agent profile manager
|
||||
gyandoot-gateway — Gateway for platform sessions, routing, streaming
|
||||
## 📦 Quick Install
|
||||
|
||||
### 🐧 Linux / 🍎 macOS / WSL
|
||||
```bash
|
||||
curl -fsSL https://git.gyannetra.in/gnpl_admin/gyandoot-release/raw/main/install.sh | bash
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
### 🪟 Windows (PowerShell)
|
||||
```powershell
|
||||
iwr -useb https://git.gyannetra.in/gnpl_admin/gyandoot-release/raw/main/windows/install.ps1 | iex
|
||||
```
|
||||
|
||||
### 🍺 macOS (Homebrew)
|
||||
```bash
|
||||
brew tap gnpl_admin/gyandoot
|
||||
brew install gyandoot
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🖥️ Platform Support
|
||||
|
||||
| OS | Architecture | Status |
|
||||
|----|-------------|--------|
|
||||
| **macOS** | arm64 (M1/M2/M3/M4), x86_64 | ✅ |
|
||||
| **Linux** | x86_64, aarch64, i686 | ✅ |
|
||||
| **WSL (Windows)** | x86_64, aarch64 | ✅ |
|
||||
| **Windows (native)** | x86_64 | ✅ (Git Bash / MSYS2) |
|
||||
|
||||
---
|
||||
|
||||
## 📋 Prerequisites
|
||||
|
||||
| Dependency | Why | Install |
|
||||
|-----------|-----|---------|
|
||||
| **Rust** (cargo ≥ 1.70) | Build GyanDoot binary | `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` |
|
||||
| **Node.js** (≥ 20) | Camoufox browser daemon | `nvm install 22` or [nodejs.org](https://nodejs.org) |
|
||||
| **Linux deps** | Camoufox browser engine | See [Linux Dependencies](#linux-dependencies) section |
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Manual Installation
|
||||
|
||||
### Step 1: Clone & Build
|
||||
```bash
|
||||
git clone https://git.gyannetra.in/gnpl_admin/gyandoot-release.git
|
||||
cd gyandoot-release
|
||||
./install.sh
|
||||
```
|
||||
|
||||
### Step 2: Verify Installation
|
||||
```bash
|
||||
gyandoot --help
|
||||
gyandoot setup # Interactive config wizard
|
||||
gyandoot run # Start the agent
|
||||
```
|
||||
|
||||
### Step 3: Browser Setup (Anti-Detection)
|
||||
```bash
|
||||
# Download Camoufox browser binary (~311MB)
|
||||
npx --yes camoufox-js@0.11.0 fetch
|
||||
|
||||
# macOS only — remove Gatekeeper quarantine
|
||||
xattr -dr com.apple.quarantine ~/Library/Caches/camoufox
|
||||
|
||||
# Verify
|
||||
ls ~/Library/Caches/camoufox/version.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🐧 Linux Dependencies
|
||||
|
||||
Camoufox (Playwright-based) needs system libraries. Install with:
|
||||
|
||||
```bash
|
||||
./install.sh
|
||||
gyandoot --help
|
||||
# Debian / Ubuntu / WSL
|
||||
sudo apt-get update && sudo apt-get install -y \
|
||||
libgtk-3-0 libnss3 libnspr4 libatk1.0-0t64 \
|
||||
libatk-bridge2.0-0t64 libcups2t64 libdrm2 \
|
||||
libxkbcommon0 libxcomposite1 libxdamage1 \
|
||||
libxfixes3 libxrandr2 libgbm1 libpango-1.0-0 \
|
||||
libcairo2 libasound2t64 libxcb-shm0
|
||||
|
||||
# Fedora / RHEL
|
||||
sudo dnf install -y nss nspr atk at-spi2-atk cups-libs \
|
||||
libdrm libXcomposite libXdamage libXrandr \
|
||||
mesa-libgbm pango alsa-lib libxkbcommon
|
||||
```
|
||||
|
||||
## License
|
||||
---
|
||||
|
||||
MIT
|
||||
## 🪟 Windows (Native)
|
||||
|
||||
### Using Git Bash / MSYS2
|
||||
```bash
|
||||
# Install Rust
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
|
||||
# Install Node.js
|
||||
# Download from: https://nodejs.org (v20+)
|
||||
|
||||
# Build & install
|
||||
git clone https://git.gyannetra.in/gnpl_admin/gyandoot-release.git
|
||||
cd gyandoot-release
|
||||
./install.sh
|
||||
```
|
||||
|
||||
### Using PowerShell
|
||||
```powershell
|
||||
# Run as Administrator
|
||||
Set-ExecutionPolicy Bypass -Scope Process -Force
|
||||
iex ((New-Object System.Net.WebClient).DownloadString('https://git.gyannetra.in/gnpl_admin/gyandoot-release/raw/main/windows/install.ps1'))
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🍺 macOS Homebrew
|
||||
|
||||
```bash
|
||||
# Tap the repository
|
||||
brew tap gnpl_admin/gyandoot
|
||||
|
||||
# Install
|
||||
brew install gyandoot
|
||||
|
||||
# Upgrade
|
||||
brew upgrade gyandoot
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚦 Getting Started
|
||||
|
||||
```bash
|
||||
# 1. Configure your LLM provider
|
||||
gyandoot setup
|
||||
|
||||
# 2. Start interactive session
|
||||
gyandoot run
|
||||
|
||||
# 3. Browser-based tasks (with anti-detection)
|
||||
gyandoot browser search "latest AI research papers"
|
||||
gyandoot browser browse https://example.com
|
||||
|
||||
# 4. Service management (auto-start on boot)
|
||||
gyandoot service install # optional
|
||||
gyandoot service status
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
```
|
||||
gyandoot run
|
||||
├── Agent Loop (LLM-powered)
|
||||
├── Browser Manager (Camoufox daemon)
|
||||
│ ├── camoufox-js@0.11.0 → fetches browser binary
|
||||
│ └── camoufox-browser@0.1.0 → daemon IPC (Unix socket)
|
||||
├── Memory Palace (Persistent recall)
|
||||
│ └── Vector-search memory at ~/.gyandoot/palace/
|
||||
└── Tool Executor
|
||||
├── web_search / web_browse (Camoufox browser)
|
||||
├── file_ops, code_exec
|
||||
└── subagent delegation
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📜 License
|
||||
|
||||
MIT — Gyannetra Pvt Ltd
|
||||
Reference in New Issue
Block a user