ebira

module
v0.8.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 16, 2026 License: AGPL-3.0

README

ebira

Yoichi took a humming-bulb arrow, set it to the string, drew it to the full and let it fly with a twang. Though he was a small man, the arrow was twelve hand-breadths and three fingers long and the bow was strong; the humming bulb sang out so long that it echoed across the bay, and without fail it struck the fan an inch or so from the rivet and cut it clean through. The arrow went into the sea, and the fan rose up into the sky. Tossed once, twice by the spring wind, it scattered down onto the sea.

The fan, all crimson with a rising sun on it, drifted on the white waves in the glow of the setting sun, sinking and rising as it rocked. Out at sea the Heike beat on the sides of their boats in admiration; on the shore the Genji beat on their quivers, their ebira, and roared.

Your notes as plain YAML files, synced with git if you like.
Searchable in Japanese and English, and shared with your AI on your terms.

Built with Goa Built with Goa-AI

English | 日本語


ebira is a note app with a strong search. Every note is a YAML file in a folder you own: keep it as it is, put it in a synced folder such as Dropbox, or let ebira sync it with git. A local server keeps a SQLite index of the notes, and serves a web UI, which also comes as a desktop app for macOS and Windows, a TUI, a REST API and an MCP server for AI clients.

Why

Plain files are the best home for notes: they outlive apps, and git gives you sync and history for free. But a folder of files is hard to search, especially in Japanese, where words are not separated by spaces. And when an AI can read your notes, you want to decide which ones.

  • Files you own — one note, one YAML file. Edit them with any editor; ebira notices.
  • Search that understands Japanese — morphological analysis finds the other forms of a word, and bigrams catch what it misses.
  • AI with boundaries — each notebook says what an AI may do with it: read, write, only drop notes in, or nothing at all.
flowchart LR
  W["🌐 web UI · 🖥️ desktop app"] --> R
  T["⌨️ TUI"] --> R
  C["🤖 AI clients"] --> M
  subgraph S["ebira server"]
    R["REST · as you"]
    M["MCP · as AI"]
    N["notes"]
    A["💬 assistant"]
    I[("🔎 SQLite index")]
    R & M --> N
    R -->|"ask"| A
    N --> A
    N <--> I
  end
  A <--> L["☁️ Claude / Gemini"]
  N <--> F["📄 YAML files"]
  F <-.->|"git · Dropbox"| O["💻 other machines"]

Web UI, desktop app and TUI

The same notes, from the browser (ebira web), from a window of their own on macOS and Windows, or from the terminal (ebira); all talk to the same local server, and each shows the others' changes as they happen.

Features

  • YAML notes in folders — <notebook>/<id>.yaml in your notes directory. Comments and unknown keys survive every update. Images and attached files live next to their note.
  • Five search modes — bigram (default), trigram, ja (Japanese morphological analysis with kagome, plus bigrams), en (English words with their stems, plus trigrams), and like. Search to rank, or filter a list in its own order.
  • Sync with Dropbox, iCloud Drive or git — the conflicted copies of sync services, and notes changed on two machines, become notes, so no change is hidden.
  • Always up to date — the index follows file changes, so git pull or another editor just works. The index is a cache: delete it and it is rebuilt.
  • Web UI and desktop app — Markdown with math (KaTeX) and diagrams (Mermaid), an editor with list continuation, code coloring and emoji completion (CodeMirror 6), marks, tags, sub notebooks, separators, an archive, drag and drop, and live updates. In English and Japanese, with light and dark themes.
  • TUI — the same notes in the terminal, driven by the keyboard.
  • MCP server and notebook kinds for AI — AI clients such as Claude Code can search and read your notes, and write where you allow it: default (AI reads), collab (AI reads and writes), drop (AI only drops notes in) and private (invisible to AI).
  • Assistant — ask about your notes in the web UI, with Claude or Gemini; it answers with links to the notes it used.
  • Safe edits — conflicts are detected with ETags, deleted notes go to the trash first, moves can be undone, and earlier versions of a note are kept on each machine.
  • A guide in your notes — a new notes directory starts with the guide of ebira, which is also the documentation.
  • One binary, no cgo

Installation

The ebira command, with the server, the web UI and the TUI, runs on macOS and Linux, and needs Go 1.27 or later:

go install github.com/ikawaha/ebira/cmd/ebira@latest

The desktop app, for macOS (13 or later) and Windows, carries the server; on Windows, it is the way to run ebira. It is not distributed yet: an install script builds it from the source and installs it, and running it again updates the app. It needs Go and git, and on macOS the Xcode Command Line Tools.

# macOS
curl -fsSL https://raw.githubusercontent.com/ikawaha/ebira/main/apps/desktop/install.sh | sh
# Windows, in PowerShell
& ([scriptblock]::Create((irm https://raw.githubusercontent.com/ikawaha/ebira/main/apps/desktop/install-windows.ps1)))

Or clone the repository, read the script and run it there; Desktop App tells how, and more.

Quick Start

ebira web

The first time, ebira asks where to keep your notes, the git repository to sync them with (if any), how to search them and the language of the screens, then starts the server in the background and opens the web UI at http://localhost:13579/. ebira opens the TUI instead. The notes start with the guide of ebira: read it from the top.

To let Claude Code in, as far as each notebook allows:

ebira mcp add

More in Installing and setting up.

Documentation

The documentation is in English and Japanese, and is also the guide in your notes. A few places to start:

License

AGPL-3.0-or-later


The icon is a detail of Fujiwara no Hidesato Shooting the Giant Centipede at the Dragon King's Palace (1890) by Tsukioka Yoshitoshi, in the public domain (Wikimedia Commons).

Directories

Path Synopsis
cmd
ebira command
Command ebira is the ebira note app: a terminal UI and a web UI, and the server behind them, which also serves the REST API and MCP.
Command ebira is the ebira note app: a terminal UI and a web UI, and the server behind them, which also serves the REST API and MCP.
Package design defines the ebira API with the Goa DSL.
Package design defines the ebira API with the Goa DSL.
Package docs holds the documentation of ebira for each language (en, ja), which is also the guide the server adds to the notes (see internal/guide): Markdown files, and guide.yaml, which tells their order in the guide.
Package docs holds the documentation of ebira for each language (en, ja), which is also the guide the server adds to the notes (see internal/guide): Markdown files, and guide.yaml, which tells their order in the guide.
gen
internal
agent
Package agent runs the assistant agent declared in the design, which answers questions about the user's notes by searching and reading them.
Package agent runs the assistant agent declared in the design, which answers questions about the user's notes by searching and reading them.
auth
Package auth authenticates people with passkeys (WebAuthn) for the REST API, so that AI clients on the same machine, which call it without a browser, are not taken for people.
Package auth authenticates people with passkeys (WebAuthn) for the REST API, so that AI clients on the same machine, which call it without a browser, are not taken for people.
authclient
Package authclient signs in the clients of the server that have no browser, the TUI and the commands, while the server requires a passkey (auth: passkey): people approve them in the web UI, signed in with a passkey (a device flow, see internal/auth), and the session they get is kept in memory only, so that other programs, such as AI agents, cannot read it from a file.
Package authclient signs in the clients of the server that have no browser, the TUI and the commands, while the server requires a passkey (auth: passkey): people approve them in the web UI, signed in with a passkey (a device flow, see internal/auth), and the session they get is kept in memory only, so that other programs, such as AI agents, cannot read it from a file.
claudecode
Package claudecode registers ebira as an MCP server of Claude Code, with its command claude, for ebira mcp add and the button of the web UI.
Package claudecode registers ebira as an MCP server of Claude Code, with its command claude, for ebira mcp add and the button of the web UI.
config
Package config reads the settings file of the ebira commands and computes where their files go, following the XDG Base Directory Specification on macOS as on Linux:
Package config reads the settings file of the ebira commands and computes where their files go, following the XDG Base Directory Specification on macOS as on Linux:
daemon
Package daemon runs the ebira server in the background, one per notes directory: the TUI starts it when it is not running, and it keeps running after the TUI exits, so that MCP clients and the web UI can use it.
Package daemon runs the ebira server in the background, one per notes directory: the TUI starts it when it is not running, and it keeps running after the TUI exits, so that MCP clients and the web UI can use it.
gitsync
Package gitsync syncs a notes directory with its git repository by running the git command: it commits the changes of the notes, merges those of the upstream branch and pushes.
Package gitsync syncs a notes directory with its git repository by running the git command: it commits the changes of the notes, merges those of the upstream branch and pushes.
guide
Package guide adds the guide of ebira to a notes directory: a notebook of notes that tell how to use ebira, each showing the feature it tells about, such as marks, separators and a sub notebook.
Package guide adds the guide of ebira to a notes directory: a notebook of notes that tell how to use ebira, each showing the feature it tells about, such as marks, separators and a sub notebook.
history
Package history keeps the earlier versions of notes on this device, so that a note can be put back as it was before it was saved or changed outside, and the files of notes replaced or deleted (see KeepFile).
Package history keeps the earlier versions of notes on this device, so that a note can be put back as it was before it was saved or changed outside, and the files of notes replaced or deleted (see KeepFile).
httpguard
Package httpguard guards the HTTP server, the REST API and MCP alike, against requests that other sites make through the browser.
Package httpguard guards the HTTP server, the REST API and MCP alike, against requests that other sites make through the browser.
importer
Package importer turns Markdown files into notes: the title, tags and times from the front matter, the first heading or the file name, the body without the front matter, and the other front matter keys to keep in the note file.
Package importer turns Markdown files into notes: the title, tags and times from the front matter, the first heading or the file name, the body without the front matter, and the other front matter keys to keep in the note file.
index
Package index is the SQLite index built from the note YAML files.
Package index is the SQLite index built from the note YAML files.
previewstyle
Package previewstyle holds the built-in styles of the preview of the web UI, and writes the one chosen to the CSS file for the preview, preview.css next to the settings file, where the user may change it.
Package previewstyle holds the built-in styles of the preview of the web UI, and writes the one chosen to the CSS file for the preview, preview.css next to the settings file, where the user may change it.
service
Package service implements the notes service (gen/notes.Service).
Package service implements the notes service (gen/notes.Service).
store
Package store reads and writes the YAML files in the notes directory.
Package store reads and writes the YAML files in the notes directory.
ui/tui
Package tui is a terminal UI for the ebira API.
Package tui is a terminal UI for the ebira API.
ui/web
Package web serves the web UI: static files embedded in the binary that call the REST API from the browser.
Package web serves the web UI: static files embedded in the binary that call the REST API from the browser.
watch
Package watch notifies changes of files in a directory and in the directories under it, down to a given depth (such as the notebooks, their sub notebooks, and the notebooks in the trash with theirs).
Package watch notifies changes of files in a directory and in the directories under it, down to a given depth (such as the notebooks, their sub notebooks, and the notebooks in the trash with theirs).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL