A Codex skill for Obsidian notes

Put your notes
to work

Use Batang to import the Obsidian notes you choose, find what you need, and use it with sources in your next task.

macOS ARM64 · Codex CLI or the ChatGPT app

Example lookup request

“Look through these notes and tell me what I need to get started. Show me which notes you used.”

Tell Batang what to look for and which notes it can read.

From notes to your next task

  1. Import your notes

    Choose notes from your vault or a folder. Batang prepares copies, records their sources, and keeps the originals intact. It registers the copies in your note list as a separate step and reports the result for each note.

    Example request

    “Import copies of the notes I chose from this folder and register them in my note list.”

  2. Find what you need

    Regular lookup covers only registered notes you choose and permit Batang to read for the current task. The answer shows the sources used and what could not be verified.

    Example request

    “Find the key concepts on this topic in the notes I chose, and explain them with sources.”

  3. Use what you find with sources

    Use the sources you checked in software, documents, and diagrams. Codex checks your request and the approved scope before carrying out the work.

    Example request

    “Turn what we found into a short guide for newcomers, and link to the notes you used.”

Get started in three steps

Read the installation guide on GitHub
  1. Set up your environment

    Use Codex CLI or the ChatGPT app on an Apple silicon Mac with an Obsidian vault. An empty vault works if you’re starting fresh.

  2. Clone the repository and ask to install

    Open your AI tool in the cloned folder and ask it to follow AGENTS.md to install Batang. Confirm your project folder and vault, and approve the settings you need.

  3. Invoke Batang

    Start your CLI request with $batang. In the ChatGPT app, type @ and select the Batang skill.

Frequently asked questions

What if a note is missing from the search results?

Check whether it is registered, selected for this task, and permitted for reading. If Batang could not read some notes, check the reported omissions and reasons.

What do the Codex model and the lookup tool do?

The lookup tool finds relevant passages in permitted notes. The Codex model checks those passages, writes the answer, and flags conflicting sources or gaps in the evidence.

When does Batang run and save?

Batang applies to tasks where you invoke it and to their follow-ups. When you ask it to save, it writes to the permitted target and backs up any existing note before editing it. Saving a conversation also requires a request.

Which tools do lookups and diagrams use?

Basic lookup uses the Python standard library. On request, Batang uses Graphify (Python) to organize relationships between notes or Archify (Node.js) to make explanatory diagrams.