omnime 0.2.5__tar.gz

omnime-0.2.5/.claude/rules/RULES.md

@@ -0,0 +1,20 @@
+# Regras para Analises dadas Questões do Usuário
+1. **Relevância**: As análises devem ser diretamente relevantes à questão do usuário, abordando os pontos específicos levantados e evitando informações desnecessárias.
+
+2. Nunca levante hipóteses ou suposições sem base sólida. Se a questão do usuário for ambígua, peça esclarecimentos antes de fornecer uma análise. Realize testes para validar/excluir/confirmar hipóteses, e baseie suas análises nos resultados desses testes. Não invente testes fáceis de passar ou que não testem o que você diz que testam.
+
+# Regras de Diagnóstico de Testes
+1. **Cobertura de Código**: Assegure-se de que os testes cubram pelo menos 80% do código, incluindo casos de borda e cenários de falha.
+
+2. **Isolamento**: Cada teste deve ser independente e não depender de outros testes ou do estado global. Use mocks e stubs para isolar as unidades de código.
+
+2. **Repetibilidade**: Os testes devem produzir os mesmos resultados em execuções subsequentes, independentemente da ordem de execução ou do ambiente.
+
+3. **Clareza**: Os testes devem ser claros e fáceis de entender. Use nomes descritivos para os testes e organize-os de maneira lógica.
+
+
+# Regras de Organização de Testes
+Nunca gere arquivos de teste soltos na raiz do projeto. Use o diretório `tests/` para organizar os testes por funcionalidade ou módulo.
+
+# Regras de Nomenclatura de Testes
+Siga a convenção de nomenclatura `test_<nome_da_funcionalidade>.py` para arquivos de teste. Dentro dos arquivos, nomeie as funções de teste com o prefixo `test_` seguido de uma descrição clara do que está sendo testado, por exemplo, `test_calculo_soma()`.

omnime-0.2.5/.claude/settings.json

@@ -0,0 +1,21 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(grep -A 30 \"checkAndEnforceHardFail\\\\|improve.*loop\\\\|composite.*tool\" /tmp/smallcode/bin/smallcode.js | head -60)",
+      "Read(//tmp/smallcode/bin/**)",
+      "Bash(python -c ' *)",
+      "Read(//home/gilzamir/**)",
+      "Bash(sed -n '/DEBUG PLAN JSON/,/\\\\/DEBUG PLAN JSON/p' /home/gilzamir/log.log)",
+      "Read(//home/gilzamir/micalc/**)",
+      "Bash(git stash *)",
+      "Bash(python -m pytest tests/ -q --ignore=tests/test_planner_output.py --ignore=tests/test_agent_config.py -k \"not llm and asyncio\")",
+      "Bash(python -m pytest tests/ -q --ignore=tests/test_planner_output.py --ignore=tests/test_agent_config.py -k \"not llm\")",
+      "Bash(python -m pytest tests/test_workflow_pipeline.py tests/test_verification_strategies.py -q -k \"asyncio or \\(not llm\\)\")",
+      "Bash(python -m pytest tests/ -x -q)",
+      "Bash(python -c \"from opalacoder.cli_commands import _registry, REPLState; print\\('OK'\\); print\\([k for k in _registry._cmds]\\)\")"
+    ],
+    "additionalDirectories": [
+      "/home/gilzamir"
+    ]
+  }
+}

omnime-0.2.5/.github/workflows/cleanup-releases.yml

@@ -0,0 +1,44 @@
+name: Cleanup Old Releases
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch: # Allows manual triggering from the Actions tab
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Delete older releases (keep last 3)
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          echo "Fetching releases..."
+          # gh release list outputs: title, release_type, tag_name, published_at
+          # we only want the tag_name, which is the 3rd column, but wait, if title has spaces, awk might break.
+          # better to use gh api or gh release list with custom format:
+          RELEASES=$(gh release list --limit 100 --exclude-drafts --exclude-pre-releases | awk '{print $(NF-1)}')
+          
+          # Alternatively, ensuring we just get the tags directly using gh api:
+          # gh api repos/{owner}/{repo}/releases -q '.[].tag_name'
+          TAGS=$(gh api repos/${{ github.repository }}/releases -q '.[].tag_name')
+          
+          TOTAL_RELEASES=$(echo "$TAGS" | wc -w)
+          
+          if [ -z "$TAGS" ] || [ "$TOTAL_RELEASES" -le 3 ]; then
+            echo "Total releases: $TOTAL_RELEASES. Keeping at most 3. Nothing to delete."
+            exit 0
+          fi
+          
+          # Skip the first 3
+          TAGS_TO_DELETE=$(echo "$TAGS" | tail -n +4)
+          
+          for tag in $TAGS_TO_DELETE; do
+            echo "Deleting release and tag: $tag"
+            gh release delete "$tag" -y --cleanup-tag || true
+          done

omnime-0.2.5/.github/workflows/main.yml

@@ -0,0 +1,2 @@
+- name: Delete Older Releases
+  uses: dev-drprasad/delete-older-releases@v0.3.4

omnime-0.2.5/.github/workflows/publish.yaml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+  release:
+    types:
+      - published
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment: omnime
+    
+    # These permissions are required for Trusted Publishing
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: pip install --upgrade pip build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # To use Trusted Publishing, you need to configure your PyPI project 
+        # to trust this GitHub repository and workflow.

omnime-0.2.5/.gitignore

@@ -0,0 +1,131 @@
+# --- Project-specific ---
+*.env
+.env
+*.env*
+.venv
+*.venv
+node_modules/
+plan.md
+
+# --- Project runtime data ---
+.opalacoder/
+
+# --- Python bytecode & caches ---
+__pycache__/
+*.py[cod]
+*$py.class
+*.pyo
+
+# --- C extensions ---
+*.so
+
+# --- Distribution / packaging ---
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# --- PyInstaller ---
+*.manifest
+*.spec
+!LinuxOpalaCoder.spec
+!OpalaCoder.spec
+
+# --- Installer logs ---
+pip-log.txt
+pip-delete-this-directory.txt
+
+# --- Testing & coverage ---
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# --- Translations ---
+*.mo
+*.pot
+
+# --- Databases ---
+*.sqlite
+*.sqlite3
+*.sqlite3-journal
+*.sqlite-shm
+*.sqlite-wal
+
+# --- Logging ---
+*.log
+
+# --- Virtual environments ---
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# --- Jupyter ---
+.ipynb_checkpoints
+
+# --- IPython ---
+profile_default/
+ipython_config.py
+
+# --- PEP 582 ---
+__pypackages__/
+
+# --- Type checkers ---
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+
+# --- Build tools ---
+.pybuilder/
+target/
+cython_debug/
+docs/_build/
+/site
+
+# --- Misc Python tools ---
+.scrapy
+instance/
+.webassets-cache
+celerybeat-schedule
+celerybeat.pid
+*.sage.py
+.spyderproject
+.spyproject
+.ropeproject
+local_settings.py
+
+# --- IDEs / Editors ---
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+*.db
+.omnime/

omnime-0.2.5/AGENTS.md

@@ -0,0 +1,35 @@
+# General Rules
+
+1. Don't make baseless assumptions; before drawing any conclusions, conduct tests and analysis to gather as much information as possible.
+
+# Project Guide
+
+## Language
+
+All code, comments, and documentation must be written in **English**.
+
+## Architecture
+
+This project uses the **AgenticBlocks.IO** framework.
+Before starting any task, read the library source and documentation at:
+https://github.com/gilzamir/agenticblocks
+
+Key things to understand from that repo:
+- How blocks are structured and composed
+- How agents communicate and dispatch events
+- Naming conventions used throughout the framework
+
+## Project Context
+
+Read `ARCH_SUMMARY.md` before making changes. It contains the current project status,
+known issues, and decisions already made. Do not re-litigate what is documented there.
+
+## Build & Test Commands
+Run tests on tests dir after you implement a new feature.
+
+
+> Fill in your actual commands below — this is the highest-value section.
+
+```bash
+python -m pytest
+```

omnime-0.2.5/AppIcons/Assets.xcassets/AppIcon.appiconset/Contents.json

@@ -0,0 +1 @@
+{"images":[{"size":"60x60","expected-size":"180","filename":"180.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"3x"},{"size":"40x40","expected-size":"80","filename":"80.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"2x"},{"size":"40x40","expected-size":"120","filename":"120.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"3x"},{"size":"60x60","expected-size":"120","filename":"120.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"2x"},{"size":"57x57","expected-size":"57","filename":"57.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"1x"},{"size":"29x29","expected-size":"58","filename":"58.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"2x"},{"size":"29x29","expected-size":"29","filename":"29.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"1x"},{"size":"29x29","expected-size":"87","filename":"87.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"3x"},{"size":"57x57","expected-size":"114","filename":"114.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"2x"},{"size":"20x20","expected-size":"40","filename":"40.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"2x"},{"size":"20x20","expected-size":"60","filename":"60.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"iphone","scale":"3x"},{"size":"1024x1024","filename":"1024.png","expected-size":"1024","idiom":"ios-marketing","folder":"Assets.xcassets/AppIcon.appiconset/","scale":"1x"},{"size":"40x40","expected-size":"80","filename":"80.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"2x"},{"size":"72x72","expected-size":"72","filename":"72.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"1x"},{"size":"76x76","expected-size":"152","filename":"152.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"2x"},{"size":"50x50","expected-size":"100","filename":"100.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"2x"},{"size":"29x29","expected-size":"58","filename":"58.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"2x"},{"size":"76x76","expected-size":"76","filename":"76.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"1x"},{"size":"29x29","expected-size":"29","filename":"29.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"1x"},{"size":"50x50","expected-size":"50","filename":"50.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"1x"},{"size":"72x72","expected-size":"144","filename":"144.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"2x"},{"size":"40x40","expected-size":"40","filename":"40.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"1x"},{"size":"83.5x83.5","expected-size":"167","filename":"167.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"2x"},{"size":"20x20","expected-size":"20","filename":"20.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"1x"},{"size":"20x20","expected-size":"40","filename":"40.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"ipad","scale":"2x"},{"idiom":"watch","filename":"172.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"38mm","scale":"2x","size":"86x86","expected-size":"172","role":"quickLook"},{"idiom":"watch","filename":"80.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"38mm","scale":"2x","size":"40x40","expected-size":"80","role":"appLauncher"},{"idiom":"watch","filename":"88.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"40mm","scale":"2x","size":"44x44","expected-size":"88","role":"appLauncher"},{"idiom":"watch","filename":"102.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"45mm","scale":"2x","size":"51x51","expected-size":"102","role":"appLauncher"},{"idiom":"watch","filename":"108.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"49mm","scale":"2x","size":"54x54","expected-size":"108","role":"appLauncher"},{"idiom":"watch","filename":"92.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"41mm","scale":"2x","size":"46x46","expected-size":"92","role":"appLauncher"},{"idiom":"watch","filename":"100.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"44mm","scale":"2x","size":"50x50","expected-size":"100","role":"appLauncher"},{"idiom":"watch","filename":"196.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"42mm","scale":"2x","size":"98x98","expected-size":"196","role":"quickLook"},{"idiom":"watch","filename":"216.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"44mm","scale":"2x","size":"108x108","expected-size":"216","role":"quickLook"},{"idiom":"watch","filename":"234.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"45mm","scale":"2x","size":"117x117","expected-size":"234","role":"quickLook"},{"idiom":"watch","filename":"258.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"49mm","scale":"2x","size":"129x129","expected-size":"258","role":"quickLook"},{"idiom":"watch","filename":"48.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"38mm","scale":"2x","size":"24x24","expected-size":"48","role":"notificationCenter"},{"idiom":"watch","filename":"55.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"42mm","scale":"2x","size":"27.5x27.5","expected-size":"55","role":"notificationCenter"},{"idiom":"watch","filename":"66.png","folder":"Assets.xcassets/AppIcon.appiconset/","subtype":"45mm","scale":"2x","size":"33x33","expected-size":"66","role":"notificationCenter"},{"size":"29x29","expected-size":"87","filename":"87.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"watch","role":"companionSettings","scale":"3x"},{"size":"29x29","expected-size":"58","filename":"58.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"watch","role":"companionSettings","scale":"2x"},{"size":"1024x1024","expected-size":"1024","filename":"1024.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"watch-marketing","scale":"1x"},{"size":"128x128","expected-size":"128","filename":"128.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"mac","scale":"1x"},{"size":"256x256","expected-size":"256","filename":"256.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"mac","scale":"1x"},{"size":"128x128","expected-size":"256","filename":"256.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"mac","scale":"2x"},{"size":"256x256","expected-size":"512","filename":"512.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"mac","scale":"2x"},{"size":"32x32","expected-size":"32","filename":"32.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"mac","scale":"1x"},{"size":"512x512","expected-size":"512","filename":"512.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"mac","scale":"1x"},{"size":"16x16","expected-size":"16","filename":"16.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"mac","scale":"1x"},{"size":"16x16","expected-size":"32","filename":"32.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"mac","scale":"2x"},{"size":"32x32","expected-size":"64","filename":"64.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"mac","scale":"2x"},{"size":"512x512","expected-size":"1024","filename":"1024.png","folder":"Assets.xcassets/AppIcon.appiconset/","idiom":"mac","scale":"2x"}]}

omnime-0.2.5/CLAUDE.md

@@ -0,0 +1,37 @@
+# General Rules
+
+1. Don't make baseless assumptions; before drawing any conclusions, conduct tests and analysis to gather as much information as possible.
+
+2. Dever apply direct patch ou modifications in external lib without user authorization.
+
+3. Dont call directly litellm (always use agenticblocks). If need same feature dont supported by agenticblocks, alert me and ask me about to do.
+
+# Project Guide
+
+## Language
+All code, comments, and documentation must be written in **English**.
+
+## Architecture
+
+This project uses the **AgenticBlocks.IO** framework.
+Before starting any task, read the library source and documentation at:
+https://github.com/gilzamir/agenticblocks
+
+Key things to understand from that repo:
+- How blocks are structured and composed
+- How agents communicate and dispatch events
+- Naming conventions used throughout the framework
+
+## Project Context
+
+Read `docs/specs` before making changes. It contains the current project status, known issues, and decisions already made. Do not re-litigate what is documented there.
+
+## Build & Test Commands
+Run tests on tests dir after you implement a new feature.
+
+
+> Fill in your actual commands below — this is the highest-value section.
+
+```bash
+python -m pytest
+```

omnime-0.2.5/GEMINI.md

@@ -0,0 +1,40 @@
+# General Rules
+
+1. Don't make baseless assumptions; before drawing any conclusions, conduct tests and analysis to gather as much information as possible. 
+
+1.1. Don't make Jerry-rig or Kludge without user authorization. Hightlight this limitation for user.
+
+2. Dever apply direct patch ou modifications in external lib without user authorization.
+
+3. Dont call directly litellm (always use agenticblocks). If need same feature dont supported by agenticblocks, alert me and ask me about to do.
+
+# Project Guide
+
+## Language
+
+All code, comments, and documentation must be written in **English**.
+
+## Architecture
+
+This project uses the **AgenticBlocks.IO** framework.
+Before starting any task, read the library source and documentation at:
+https://github.com/gilzamir/agenticblocks
+
+Key things to understand from that repo:
+- How blocks are structured and composed
+- How agents communicate and dispatch events
+- Naming conventions used throughout the framework
+
+## Project Context
+
+Read `docs/specs` before making changes. It contains the current project status, known issues, and decisions already made. Do not re-litigate what is documented there.
+
+## Build & Test Commands
+Run tests on tests dir after you implement a new feature.
+
+
+> Fill in your actual commands below — this is the highest-value section.
+
+```bash
+python -m pytest
+```

omnime-0.2.5/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: omnime
+Version: 0.2.5
+Summary: Autonomous coding agent with interactive planning and modular execution
+Project-URL: Homepage, https://github.com/omnimedev/OmniMe
+Project-URL: Bug Tracker, https://github.com/omnimedev/OmniMe/issues
+Author-email: Gilzamir Gomes <dev@omnime.com>
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: agenticblocks-io>=0.9.10
+Requires-Dist: chromadb>=0.4.0
+Requires-Dist: ddgs>=6.0
+Requires-Dist: duckduckgo-search>=6.4.0
+Requires-Dist: instructor>=1.15.1
+Requires-Dist: litellm>=1.40.0
+Requires-Dist: numpy>=1.21.0
+Requires-Dist: pillow>=10.0.0
+Requires-Dist: pymupdf4llm>=0.0.17
+Requires-Dist: pyqt6-webengine>=6.0.0
+Requires-Dist: pyqt6>=6.0.0
+Requires-Dist: pytest-asyncio>=0.23.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pywebview>=4.0
+Requires-Dist: pywinpty>=2.0.0; sys_platform == 'win32'
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: qtpy>=2.4.0
+Requires-Dist: rich>=13.0.0
+Provides-Extra: embeddings
+Requires-Dist: sentence-transformers>=3.0.0; extra == 'embeddings'
+Description-Content-Type: text/markdown
+
+# OmniMe
+
+**OmniMe** is your ultimate AI-powered assistant and intelligent agent, built to supercharge your development workflow. Whether you're brainstorming new ideas, writing complex features, or squashing bugs, OmniMe adapts to your needs with an incredibly flexible and powerful architecture. 
+
+Designed with freedom in mind, OmniMe seamlessly supports both cloud-based and local LLMs—giving you full control over your code and privacy. It shines exceptionally well with local models powered by **Ollama**, allowing you to harness state-of-the-art AI without leaving your machine.
+
+---
+
+## Why Choose OmniMe?
+
+🚀 **Your Personal AI Agent**
+OmniMe isn't just an autocomplete tool; it's a fully-fledged AI agent that understands your project context. It works alongside you to handle diverse coding tasks, from interactive planning to automated bug fixing.
+
+🧠 **Persistent Memory & Context**
+Never repeat yourself. OmniMe features a persistent memory system that remembers your project's unique quirks, design decisions, and past conversations. It maintains focus, ensuring that the AI has exactly the context it needs, right when it needs it.
+
+🛠️ **Flexible, Skill-Based Architecture**
+Tailor your assistant to your exact workflow. OmniMe uses a highly modular "Skills" system. Equip your agent with specific abilities—like web research, advanced refactoring, or custom scripts—allowing it to tackle different tasks seamlessly using specialized sub-agents. 
+
+☁️ **Cloud or Local: You Decide**
+Enjoy the best of both worlds. Connect to powerful cloud models or run completely offline with local LLMs. OmniMe is heavily optimized for **Ollama**, making it incredibly easy to run powerful open-weights models locally on your own hardware.
+
+---
+
+## Getting Started
+
+### Installation
+
+Install OmniMe directly via pip:
+
+```bash
+pip install omnime
+```
+
+Or run it from source:
+
+```bash
+git clone https://github.com/omnimedev/OmniMe
+cd OmniMe
+python -m venv .env
+source .env/bin/activate          # Linux/macOS
+# .env\Scripts\activate           # Windows
+
+# Install OmniMe dependencies
+pip install -r requirements.txt
+```
+
+### Running OmniMe
+
+OmniMe comes with a beautiful, integrated Web-Based GUI that works seamlessly across platforms:
+
+```bash
+python main.py
+```
+
+*Don't like GUIs? OmniMe also supports an interactive CLI REPL and a headless JSON protocol server!*
+
+---
+
+## Deep Dive: How It Works
+
+Curious about what powers OmniMe under the hood? Want to learn about our MemGPT orchestrator, shadow git versioning, and modular skill designs?
+
+👉 **[Read the Technical Overview](docs/overview.md)**
+
+---
+
+## Community & License
+
+OmniMe is proudly open source and available under the **MIT** license.
+
+*   **Repository**: [https://github.com/omnimedev/OmniMe](https://github.com/omnimedev/OmniMe)