overai 1.4.19 → 1.4.20

package/README.md

@@ -48,7 +48,259 @@ npm install overai
 
 ## ✨ Auto-Coder CLI (Magic Project Generator)
 
-## 👤 Author
+Want to build a project instantly? OverAI includes a powerful CLI that can scaffold entire projects (React, Node, Python, etc.) from a single prompt.
+
+**Usage:**
+
+```bash
+# 1. Set your API Key (OpenAI, Gemini, or Anthropic)
+export OPENAI_API_KEY=sk-... 
+# OR
+export GOOGLE_API_KEY=AIza...
+
+# 2. Run the magic command
+npx overai-create "A personal portfolio website with HTML/CSS"
+```
+
+**Options:**
+
+*   **Auto-Detection**: The CLI automatically picks the best model based on your environment variables.
+*   **Force Model**: You can specify a model manually:
+    ```bash
+    npx overai-create "A snake game in Python" --model google/gemini-2.0-flash-exp
+    ```
+
+---
+
+## ⚡ Quick Start: Gemini Example
+
+1. **Create `tsconfig.json`**:
+```json
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "target": "ES2020",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "ts-node": {
+    "esm": true,
+    "experimentalSpecifierResolution": "node"
+  }
+}
+```
+
+2. **Create `main.ts`**:
+```typescript
+import { Agent, OverAI } from 'overai';
+
+async function main() {
+  // 1. Créer un agent
+  const agent = new Agent({
+    name: "GeminiAgent",
+    instructions: "Tu es Gemini, un modèle de Google. Réponds en français.",
+    llm: "google/gemini-2.0-flash",
+    verbose: true
+  });
+
+  // 2. Configurer OverAI avec l'agent et une tâche
+  const overAI = new OverAI({
+    agents: [agent],
+    tasks: ["Explique-moi ce qu'est un Agent IA en une phrase simple."],
+    verbose: true
+  });
+
+  // 3. Lancer l'exécution
+  console.log("🚀 Démarrage de OverAI...");
+  try {
+    const result = await overAI.start();
+    console.log("\n✅ Résultat :");
+    console.log(result);
+  } catch (error) {
+    console.error("❌ Erreur :", error);
+  }
+}
+
+main();
+```
+
+3. **Run the agent**:
+```bash
+export GOOGLE_API_KEY="your-gemini-key"
+npx tsx main.ts
+```
+
+---
+
+## 🤝 Multi-Agent Collaboration
+
+Create a team of agents that work together.
+
+```typescript
+import { Agent, OverAI } from 'overai';
+
+async function main() {
+    const researcher = new Agent({
+        name: "Researcher",
+        instructions: "Research the latest trends in AI.",
+    });
+
+    const writer = new Agent({
+        name: "Writer",
+        instructions: "Write a blog post based on the research provided.",
+    });
+
+    const overAI = new OverAI({
+        agents: [researcher, writer],
+        tasks: [
+            "Research 3 top AI trends for 2025.",
+            "Write a short blog post summarizing these trends."
+        ],
+        verbose: true
+    });
+
+    await overAI.start();
+}
+main();
+```
+
+---
+
+## 💸 SaaS & Monetization Starter Kit
+
+OverAI comes with a **complete SaaS API Server example**. Use this to launch your own AI business.
+
+### Features Included:
+- **Authentication**: Secure API Key middleware (`x-api-key`).
+- **Billing System**: Credit deduction per request (1 credit = 1 request).
+- **Payment Gateway**: Mock Stripe integration to simulate top-ups.
+- **Webhooks**: N8N compatible endpoints.
+
+### How to Run Your SaaS Backend:
+
+1. **Set your OpenAI Key**:
+   ```bash
+   export OPENAI_API_KEY="sk-..."
+   ```
+
+2. **Start the Server**:
+   ```bash
+   npx ts-node examples/saas-server.ts
+   ```
+   *Server starts at `http://localhost:3001`*
+
+3. **Test Monetization**:
+   *   **Top-up Credits** (Simulate Stripe):
+       ```bash
+       curl -X POST http://localhost:3001/api/billing/topup \
+         -H "Content-Type: application/json" \
+         -H "x-api-key: sk_demo_12345" \
+         -d '{"amount": 10.00}'
+       ```
+   *   **Paid Chat Request**:
+       ```bash
+       curl -X POST http://localhost:3001/api/v1/agent/chat \
+         -H "Content-Type: application/json" \
+         -H "x-api-key: sk_demo_12345" \
+         -d '{"message": "Hello, I paid for this!"}'
+       ```
+
+---
+
+## 🔌 Integrations & Workflows
+
+### N8N Integration
+OverAI agents can be triggered via webhooks, making them perfect for N8N workflows.
+
+```typescript
+// Example N8N Webhook Endpoint (included in saas-server.ts)
+app.post('/api/webhook/n8n', async (req, res) => {
+    const { workflow_data } = req.body;
+    // Process N8N data with agents...
+    res.json({ status: "success", result: agentResponse });
+});
+```
+
+### Model Context Protocol (MCP)
+Support for the MCP standard allows your agents to safely access local files, databases, and external tools without custom glue code.
+
+---
+
+## 🛠️ Development
+
+To contribute or modify the framework:
+
+1. **Clone your fork**:
+   ```bash
+   git clone https://github.com/your-username/overai.git
+   cd overai
+   ```
+
+2. **Install & Build**:
+   ```bash
+   npm install
+   npm run build
+   ```
+
+## 💰 Business-in-a-Box (SaaS Starter Kit)
+
+Launch your own AI API business in minutes. We provide a complete **SaaS Server Example** including:
+*   **Stripe Integration** (Mock): Simulate payments and top-ups.
+*   **Credit System**: Deduct credits per request (1 credit = 1 request).
+*   **API Authentication**: Secure endpoints with API Keys.
+*   **Rate Limiting**: Prevent abuse from free users.
+
+**Run the SaaS Server:**
+```bash
+# Install dependencies
+npm install express @types/express
+
+# Run the server
+npx ts-node examples/saas-server.ts
+```
+
+**Test your API:**
+```bash
+curl -X POST http://localhost:3001/api/v1/agent/chat \
+  -H "Content-Type: application/json" \
+  -H "x-api-key: sk_demo_12345" \
+  -d '{"message": "Hello, explain how you work in 1 sentence."}'
+```
+
+## 🏢 Enterprise & Licensing (Open Core)
+
+OverAI follows an **Open Core** model. The core framework is MIT-licensed and free forever. 
+For enterprises requiring advanced features, we provide a commercial license that unlocks:
+
+*   **SSO & Identity**: Integrate with Okta, Active Directory, and Google Workspace.
+*   **Audit Logs**: Comprehensive tracking of every agent action for compliance.
+*   **Role-Based Access Control (RBAC)**: Fine-grained permissions for teams.
+*   **Priority Support**: SLA-backed support with < 4h response time.
+
+To enable enterprise features:
+
+```typescript
+import { license } from 'overai';
+
+// Verify your license key
+await license.setLicenseKey(process.env.OVERAI_LICENSE_KEY);
+
+if (license.hasFeature('audit_logs')) {
+  console.log("✅ Enterprise Audit Logs Enabled");
+}
+```
+
+Contact **sales@overai.com** for pricing and details.
+
+## License
+
+MIT
+
+## Author
 
 **JMK**
 *   Email: anouslecode@gmail.com

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "overai",
-  "version": "1.4.19",
+  "version": "1.4.20",
   "description": "OverAI TypeScript AI Agents Framework - Build, Deploy, and Monetize AI Agents in Minutes",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",