Skip to content
    ↑↓ select↵ openesc close
    English中文
    JayJiangCT

    Byoao

    v2.0.15Other
    @jayjiang/byoao

    Build Your Own AI OS — Obsidian + AI Agent

    GitHub stars

    5

    Monthly installs

    276

    15 in 7 days

    Composite scoreSCORE

    35.5

    Multi-signal model

    Last commit

    3 months ago

    2026-04-30

    Install and configure

    opencode.json

    Writes to this project's opencode.json — applies to this repository only.

    opencode.json

    {
      "$schema": "https://opencode.ai/config.json",
      "plugin": ["@jayjiang/byoao@2.0.15"]
    }

    opencode loads npm dependencies through its embedded runtime on startup and caches them locally — no manual global install needed.

    BYOAO — Build Your Own AI OS

    Turn Obsidian into an AI-powered LLM Wiki knowledge base

    npm version license


    What is BYOAO?

    BYOAO is an OpenCode plugin that turns Obsidian into an AI-powered LLM Wiki. Write notes freely, then let AI compile structured knowledge — entities, concepts, comparisons, and answers — from your scattered files.

    • Local-first — your data stays on your machine
    • AI-nativeAGENTS.md lets AI agents navigate your knowledge base without RAG
    • Brownfield — installs alongside your existing notes, no migration needed. Run /cook to compile knowledge.

    Inspired by Andrej Karpathy's LLM Wiki — the pattern of using LLMs to incrementally build and maintain a persistent, interlinked wiki from raw notes, rather than re-deriving knowledge on every query. BYOAO is an opinionated implementation of this pattern on top of Obsidian + OpenCode.

    Prerequisites

    Requirement What it is How to install
    Obsidian Where you write and browse notes Download from obsidian.md (latest version)
    Node.js 18+ JavaScript runtime (needed to install BYOAO) Download the LTS version from nodejs.org. This also installs npm (the package manager) automatically
    OpenCode AI engine that runs BYOAO's skills npm install -g opencode or download from opencode.ai

    Recommended: Obsidian Web Clipper

    Install Obsidian Web Clipper to capture articles, research, and references directly into your vault from any browser. Clipped pages become raw material for /cook — the AI compiles them into structured knowledge alongside your own notes.

    • Customizable templates auto-apply frontmatter (author, tags, source URL)
    • Highlight passages on any web page and save them to Obsidian in one click
    • Everything stays local as plain Markdown — no lock-in

    Never used a terminal before? On Mac, open Terminal (search "Terminal" in Spotlight). On Windows, open PowerShell. You only need the terminal for installation — after setup, everything happens inside Obsidian.

    Verify your setup:

    node --version    # should print v18.x.x or higher
    npm --version     # should print a version number (comes with Node.js)
    

    Quick Start

    npm install -g @jayjiang/byoao
    byoao install
    byoao init
    

    Then open in Obsidian, enable CLI, and run /cook to compile your notes into knowledge.

    Read the full guide | Guide source

    What You Get

    Component Description
    /cook Compile notes into structured knowledge — entities, concepts, comparisons, queries
    /health Audit agent pages for orphans, broken links, stale content, taxonomy drift
    /prep Enrich frontmatter and cross-references across all notes
    /wiki Refresh INDEX.base (Bases wiki index) and update AGENTS.md stats
    /organize Reorganize vault directories safely via Obsidian CLI
    /trace Track how an idea evolved over time
    /connect Bridge two seemingly unrelated topics
    /ideas Generate actionable ideas from your vault
    /challenge Pressure-test a belief against your own notes
    /drift Compare stated intentions vs actual behavior
    /ask Open-ended Q&A against your knowledge base
    /mise Full vault structural health check

    Documentation

    Roadmap

    • Personal KB with minimal preset (v0.6)
    • /weave — knowledge graph builder (v0.6)
    • Mode A/B init — fresh + existing folder adoption (v0.6)
    • /trace, /connect — thinking tools (v0.7)
    • /ideas, /challenge, /drift — proactive intelligence (v0.8)
    • LLM Wiki v2 — /cook compilation, /health audit, brownfield architecture (v2.0)

    License

    MIT