octarine-notes

Octarine Notes

Octarine is a local-first note-taking app. Notes are plain Markdown files in a user-selected workspace, and Octarine watches the filesystem for changes. To save content into Octarine, write files into the workspace; do not use an API.

Workspace Discovery

Before creating or editing notes, identify the Octarine workspace.

1. Check whether the user has already provided a workspace path in the current conversation, agent memory, AGENTS.md, CLAUDE.md, or another global config.
2. Walk up from the current working directory. If a parent contains .octarine/, treat that parent as the workspace root.
3. If no workspace is known, ask the user for the Octarine workspace path.
4. Validate the workspace before writing. The directory should exist and contain .octarine/.
5. After the user confirms a valid workspace path, persist it in global agent memory or global config when available so future sessions can reuse it.

Do not guess a default workspace path. Common locations such as ~/Documents/Octarine/ are only suggestions to help the user find the folder.

Workspace Layout

Typical workspace structure:

<workspace>/
├── *.md
├── <folder>/*.md
├── Daily/
│   └── Weekly/
├── .templates/
├── .attachments/
├── .files/
└── .octarine/

Rules:

• Never modify .octarine/.
• Avoid custom dot-prefixed folders unless the user has enabled dot-folders in Octarine.
• Write notes as .md files.
• Put images and media in .attachments/.
• Put imported non-Markdown files in .files/.
• Avoid node_modules and .git folder names; Octarine ignores them.

Writing Notes

Write Markdown files directly into the workspace.

# My Note Title

Content goes here.

Save as:

<workspace>/My Note Title.md

For notes in folders, create directories as needed:

<workspace>/Projects/Alpha/design-doc.md
<workspace>/Areas/Health/workout-log.md

Use safe filenames:

• Use .md extension.
• Avoid < > : " / \ | ? * inside a filename segment.
• Spaces are supported.
• If a same-name file exists and the user did not ask to overwrite it, append a number such as Note 1.md.