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.
|
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. |
|
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). |
Click to show internal directories.
Click to hide internal directories.