# Octarine Documentation > Octarine is a fast, private markdown editor designed to help you capture ideas, organize knowledge, and get things done. This file contains the complete documentation for Octarine, formatted for AI agents and LLMs. Canonical docs: https://docs.octarine.app Sitemap: https://docs.octarine.app/sitemap.xml ## Table of Contents ### Getting Started - [Meet Octarine](https://docs.octarine.app/getting-started/meet-octarine) - [Installation](https://docs.octarine.app/getting-started/installation) - [Updating Octarine](https://docs.octarine.app/getting-started/updating) - [Uninstalling Octarine](https://docs.octarine.app/getting-started/uninstalling) - [Pro License](https://docs.octarine.app/getting-started/pro-license) ### Core Concepts - [Workspaces](https://docs.octarine.app/core-concepts/workspaces) - [Split panes & Tabs](https://docs.octarine.app/core-concepts/panes-and-tabs) - [Storing Data](https://docs.octarine.app/core-concepts/storing-data) - [Workspace Search](https://docs.octarine.app/core-concepts/workspace-search) - [Graph](https://docs.octarine.app/core-concepts/graph) ### Editing and Formatting - [Basics](https://docs.octarine.app/editor/basics) - [Formatting](https://docs.octarine.app/editor/formatting) - [Doclinks](https://docs.octarine.app/editor/doclinks) - [Bubble Menu](https://docs.octarine.app/editor/bubble-menu) - [Attachments](https://docs.octarine.app/editor/attachments) - [Video Annotation](https://docs.octarine.app/editor/video-annotation) - [Tables](https://docs.octarine.app/editor/tables) - [Code Blocks](https://docs.octarine.app/editor/code-blocks) - [Mermaid](https://docs.octarine.app/editor/mermaid) - [LaTeX](https://docs.octarine.app/editor/latex) - [Callout](https://docs.octarine.app/editor/callout) - [Heading Font](https://docs.octarine.app/editor/heading-font) - [Collapsible Headings](https://docs.octarine.app/editor/collapsible-headings) - [Text Color](https://docs.octarine.app/editor/text-color) - [Focus Mode](https://docs.octarine.app/editor/focus-mode) ### Organization - [File Tree](https://docs.octarine.app/organization/tree) - [Tagging](https://docs.octarine.app/organization/tagging) - [Templates](https://docs.octarine.app/organization/templates) - [Views](https://docs.octarine.app/organization/views) ### Customisation - [Themes](https://docs.octarine.app/customisation/themes) - [Theme Creator](https://docs.octarine.app/customisation/theme-creator) - [Folder Sorting and Icons](https://docs.octarine.app/customisation/folder-sorting-and-icons) ### Daily Desk - [Daily Desk](https://docs.octarine.app/daily-desk/index) - [Smart Dates](https://docs.octarine.app/daily-desk/smart-dates) - [Migrate Incomplete Tasks](https://docs.octarine.app/daily-desk/automation) ### Note Management - [Properties](https://docs.octarine.app/note-management/properties) - [Note types](https://docs.octarine.app/note-management/note-types) - [Search](https://docs.octarine.app/note-management/search) - [Pinned Notes & Folders](https://docs.octarine.app/note-management/pinned) - [Meta Sidebar](https://docs.octarine.app/note-management/meta-sidebar) - [Read-only Notes](https://docs.octarine.app/note-management/read-only-notes) - [External Files](https://docs.octarine.app/note-management/external-files) - [Outline Navigation](https://docs.octarine.app/note-management/outline-navigation) ### Working with AI - [Configuring AI](https://docs.octarine.app/working-with-ai/setting-things-up) - [Working with Codex](https://docs.octarine.app/working-with-ai/working-with-codex) - [Working with Ollama](https://docs.octarine.app/working-with-ai/working-with-ollama) - [Working with LM Studio](https://docs.octarine.app/working-with-ai/working-with-lmstudio) - [Skills](https://docs.octarine.app/working-with-ai/skills) - [Writing Assistant](https://docs.octarine.app/working-with-ai/writing-assistant) - [Ask Octarine](https://docs.octarine.app/working-with-ai/ask-octarine) - [Weekly AI Recap](https://docs.octarine.app/working-with-ai/weekly-ai-recap) ### Backup - [Git Sync](https://docs.octarine.app/backup/git-sync) - [Dropbox](https://docs.octarine.app/backup/dropbox) - [OneDrive](https://docs.octarine.app/backup/onedrive) - [iCloud](https://docs.octarine.app/backup/iCloud) - [Syncthing](https://docs.octarine.app/backup/syncthing) ### Workflows - [URI Scheme](https://docs.octarine.app/workflows/uri-scheme) - [Hookmark](https://docs.octarine.app/workflows/hookmark) - [Web clip bookmarklet](https://docs.octarine.app/workflows/web-clip-bookmarklet) - [Default Folder Location](https://docs.octarine.app/workflows/default-folder) - [Inbox](https://docs.octarine.app/workflows/inbox) - [Quick Capture](https://docs.octarine.app/workflows/quick-capture) ### Migrate from other apps - [Obsidian](https://docs.octarine.app/importing/obsidian) - [Apple Notes](https://docs.octarine.app/importing/apple-notes) - [Bear](https://docs.octarine.app/importing/bear) - [iA Writer](https://docs.octarine.app/importing/ia-writer) - [UpNote](https://docs.octarine.app/importing/upnote) - [Craft](https://docs.octarine.app/importing/craft) - [Notion](https://docs.octarine.app/importing/notion) - [Agenda](https://docs.octarine.app/importing/agenda) - [Logseq](https://docs.octarine.app/importing/logseq) - [NotePlan](https://docs.octarine.app/importing/noteplan) ### Help & Support - [Troubleshooting](https://docs.octarine.app/help/troubleshooting) - [Refund Policy](https://docs.octarine.app/help/refunds) ### Getting Started - [Meet the companion](https://docs.octarine.app/iOS/getting-started) - [Workspaces](https://docs.octarine.app/iOS/workspaces) ### Core Concepts - [Navigating the App](https://docs.octarine.app/iOS/navigating-the-app) - [Home](https://docs.octarine.app/iOS/home) - [Command Bar](https://docs.octarine.app/iOS/command-bar) ### Editing and Formatting - [Editor](https://docs.octarine.app/iOS/editor) - [Wikilinks & Tags](https://docs.octarine.app/iOS/wikilinks-and-tags) - [Attachments](https://docs.octarine.app/iOS/attachments) ### Note Management - [Notes](https://docs.octarine.app/iOS/notes) - [Pinned Notes](https://docs.octarine.app/iOS/pinned-notes) - [Search](https://docs.octarine.app/iOS/search) - [Templates](https://docs.octarine.app/iOS/templates) ### Daily Desk - [Daily Desk](https://docs.octarine.app/iOS/daily-desk) ### Inbox - [Inbox & Quick Capture](https://docs.octarine.app/iOS/inbox) -------------------------------------------------------------------------------- title: "Meet Octarine" description: "A quick overview of Octarine, a private Markdown editor for notes, knowledge management, daily planning, and AI-assisted writing." source: "https://docs.octarine.app/getting-started/meet-octarine" -------------------------------------------------------------------------------- # Meet Octarine Welcome to Octarine! We're excited to have you. Octarine is a fast, private markdown editor designed to help you capture ideas, organize knowledge, and get things done. ![Image](https://octarine.app/images/new_landing.png) ## Key Features - [Distraction-Free Writing](https://docs.octarine.app/editor/basics): A clean WYSIWYG editor that stays out of your way, letting you focus on what matters—your ideas. - [Local-First & Private](https://docs.octarine.app/core-concepts/storing-data): Your notes are stored as plain markdown files on your device. No cloud lock-in, no subscription required for core features. - [Daily Desk](https://docs.octarine.app/daily-desk/index): Start each day with a dedicated space for tasks, notes, and quick capture. Stay organized without the overhead. - [AI-Powered Assistance](https://docs.octarine.app/working-with-ai/writing-assistant): Get help with writing, summarization, and more using your preferred AI provider—local or cloud-based. - [Powerful Search](https://docs.octarine.app/core-concepts/workspace-search): Find anything instantly with workspace-wide search, including full-text search across all your notes. - [Flexible Organization](https://docs.octarine.app/organization/tree): Use folders, tags, properties, and views to organize your notes the way you think. ## Join the Community Octarine is built with care, and we love hearing from our users. Connect with us to share feedback, report issues, or suggest new features. - [Join Discord](https://octarine.app/discord) - [Twitter / X](https://octarine.app/twitter) - [Request Features or Report Bugs](https://octarine.app/issues) > **Note:** Octarine is actively evolving, and documentation may not always reflect the latest features. Check the [changelog](https://octarine.app/changelog) for the most up-to-date information — the docs will catch up soon. #### Quick Answers ### What is Octarine? Octarine is a private Markdown editor for writing notes, organizing knowledge, planning daily work, and using AI assistance with your own workspace context. ### Where does Octarine store notes? Octarine stores notes as plain Markdown files on your device, so your workspace stays portable and local-first. ### Can Octarine work with AI tools? Yes. Octarine can connect to local and cloud AI providers for features like Writing Assistant, Ask Octarine, and weekly recaps. -------------------------------------------------------------------------------- title: "Installation" description: "Platform-specific setup instructions for Octarine" source: "https://docs.octarine.app/getting-started/installation" -------------------------------------------------------------------------------- # Installation ## Download Octarine Head over to the [releases page](https://octarine.app/releases) and pick the version that matches your operating system. ## macOS ### Standard Installation 1. Download the `.dmg` file for your Mac: - **macOS (ARM)** for Apple Silicon Macs (M1/M2/M3/M4) - **macOS (Intel)** for older Intel-based Macs 2. Open the downloaded `.dmg` file 3. Drag the Octarine icon to your Applications folder 4. Eject the disk image 5. Launch Octarine from your Applications folder After the first manual installation, Octarine will periodically check for updates and install them automatically. ## Windows ### Standard Installation 1. Download the `.msi` installer 2. Run the installer file 3. If you see a blue security screen warning, click **Run Anyway** (the Windows version isn't notarized yet because the process is tricky and expensive, but it's completely safe) 4. Follow the on-screen instructions and choose your installation location 5. Launch Octarine from the Start menu After the first manual installation, Octarine will periodically check for updates. > On Windows, you might see the standard "repair/upgrade" installation prompt during future updates. ## Linux Octarine ships in multiple formats for Linux: AppImage, RPM, TAR, Debian, and Arch Linux. ### AppImage (Recommended) The AppImage version supports automatic updates. Here's how to install it: 1. Download the AppImage file 2. Open a terminal in the directory where you downloaded the file 3. Make it executable: ```bash chmod +x Octarine__amd64.AppImage ``` 4. Run the app: ```bash ./Octarine__amd64.AppImage ``` ### Other Formats For RPM, DEB, TAR, or Arch packages, follow the standard installation process for your distribution. Note that these formats may not support automatic updates—you'll need to manually download new versions from the [releases page](https://octarine.app/releases). ### Troubleshooting **Wayland users with RPM:** If you're running into issues on Wayland, try forcing the X11 backend and disabling hardware compositing with these environment variables: ```bash GDK_BACKEND=x11 LIBGL_ALWAYS_SOFTWARE=1 WEBKIT_DISABLE_COMPOSITING_MODE=1 octarine ``` #### Quick Answers ### Where can I download Octarine? Download Octarine from the [releases page](https://octarine.app/releases), then choose the installer for your operating system. ### Does Octarine support macOS, Windows, and Linux? Yes. Octarine provides builds for macOS, Windows, and Linux. ### Which Linux package should I use? Use the AppImage if you want the recommended Linux package with automatic update support. -------------------------------------------------------------------------------- title: "Updating Octarine" description: "How Octarine keeps itself up to date" source: "https://docs.octarine.app/getting-started/updating" -------------------------------------------------------------------------------- # Updating Octarine Octarine is designed to keep itself up to date automatically. You'll always be running the latest version with minimal effort. ## Auto-updates By default, Octarine checks for updates and downloads them automatically. The following installation packages support automatic updates: - Mac `.dmg` - Windows `.msi` - Linux `.AppImage` When an update is available, you'll see a small "Update Available" button in the breadcrumb at the top-right of the app. Click it, and Octarine will download the update, install it, and restart automatically. > On Windows, you might see the standard "repair/upgrade" installation prompt during the update process. If you're on a Linux package that doesn't support auto-updates (RPM, DEB, TAR, or Arch), you'll need to manually download the latest version from the [releases page](https://octarine.app/releases). ## How to check for updates Octarine checks for updates every 24 hours automatically. To check manually: 1. Open the Command Palette (`Cmd/Ctrl + K`) 2. Type and select **Check for updates** Alternatively, click the **Check for updates** option in the Help menu (the `?` icon in the bottom-right corner). ## How to check your current version To see which version of Octarine you're running: 1. Open the Command Palette (`Cmd/Ctrl + K`) 2. Type and select **About Octarine** ## Rolling back an update Rolling back to a previous version isn't currently supported. If you encounter issues with a new update, please report it on the [Feedback Tracker](https://github.com/rajatkulkarni95/octarine-feedback/issues) so it can be addressed. #### Quick Answers ### Does Octarine update automatically? Yes. Octarine checks for updates automatically every 24 hours and supports auto-updates on macOS `.dmg`, Windows `.msi`, and Linux `.AppImage` builds. ### How do I manually check for updates? Open the Command Palette with `Cmd/Ctrl + K`, then run **Check for updates**. You can also use the Help menu from the `?` icon. ### Can I roll back to an older version? Not currently. If a new update causes trouble, report it on the Feedback Tracker so it can be fixed. -------------------------------------------------------------------------------- title: "Uninstalling Octarine" description: "How to remove Octarine from your system" source: "https://docs.octarine.app/getting-started/uninstalling" -------------------------------------------------------------------------------- # Uninstalling Octarine This guide covers how to uninstall Octarine on different operating systems. ## macOS 1. Quit Octarine if it's running 2. Open Finder and go to your Applications folder 3. Drag Octarine to the Trash (or right-click and select "Move to Trash") 4. Empty the Trash ### Removing User Data (Optional) To completely remove all Octarine configuration files and data: 1. Open Finder 2. Press `Cmd + Shift + G` to open "Go to Folder" 3. Delete the following directory if it exists: - `~/Library/Application Support/Octarine` ## Windows 1. Quit Octarine if it's running 2. Open Settings (`Windows key + I`) 3. Go to **Apps** > **Installed apps** (or "Apps & features" on Windows 10) 4. Search for "Octarine" 5. Click the three dots menu next to Octarine and select **Uninstall** 6. Follow the prompts to complete the uninstallation Alternatively: 1. Open the Start menu 2. Right-click on Octarine 3. Select **Uninstall** ### Removing User Data (Optional) To completely remove all Octarine configuration files and data: 1. Press `Windows key + R` to open Run 2. Type `%APPDATA%` and press Enter 3. Delete the `Octarine.app` folder if it exists ## Linux ### AppImage Simply delete the AppImage file you downloaded. ### Other Formats For packages installed via your distribution's package manager, use the appropriate uninstall command: **Debian/Ubuntu:** ```bash sudo apt remove octarine ``` **Fedora/RPM:** ```bash sudo dnf remove octarine ``` **Arch Linux:** ```bash sudo pacman -R octarine ``` ### Removing User Data (Optional) To completely remove all Octarine configuration files and data, delete the following directory: ```bash rm -rf ~/.config/Octarine.app ``` ## Troubleshooting - **macOS/Windows:** Ensure Octarine is completely quit before attempting to uninstall. Check Activity Monitor (macOS) or Task Manager (Windows) for any running Octarine processes. - **All platforms:** If you want to start fresh while keeping Octarine installed, you can delete the configuration directories instead of uninstalling the application entirely. If you run into issues, please report them on the [Feedback Tracker](https://github.com/rajatkulkarni95/octarine-feedback/issues). #### Quick Answers ### How do I uninstall Octarine on macOS? Quit Octarine, open Applications in Finder, drag Octarine to the Trash, then empty the Trash. ### Does uninstalling Octarine delete my notes? Uninstalling the app does not automatically delete your workspace notes. Only remove your workspace folder or configuration folders if you intentionally want to delete that data. ### Where is Octarine user data stored? On macOS it is under `~/Library/Application Support/Octarine`, on Windows under `%APPDATA%/Octarine.app`, and on Linux under `~/.config/Octarine.app`. -------------------------------------------------------------------------------- title: "Pro License" description: "Unlock additional features with a one-time Pro license purchase." source: "https://docs.octarine.app/getting-started/pro-license" -------------------------------------------------------------------------------- # Pro License Octarine is free to use, but if you want access to advanced features like AI integration, properties, and more, you can upgrade to Pro. It's a one-time purchase—no subscriptions, no recurring fees. Pay once and you're set for life. ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/pro_license.png) Check out everything included in Pro at https://octarine.app/pricing ### Early Access Pricing Octarine uses an early access pricing model, kind of like Steam Early Access games. Here's how it works: As new Pro features get added, the price goes up—but if you buy now, you lock in this price forever and get all future Pro features included. No extra charges, no upgrades to buy. Just one payment, lifetime access. ### Activating Your License Once you've purchased a Pro license, activating it is quick. Click the `Upgrade to Pro` button in Octarine, enter your license key, and the Pro features unlock immediately. ### Deactivating Your License Need to switch devices? You can deactivate your license from a device in two ways: Go to `Settings → Pro` and press **Deactivate License**, or manage your devices from the [Octarine Dashboard](https://octarine.app/dashboard) or the LemonSqueezy dashboard link that came in your order email. > A Pro license works on 3 devices at the same time. If you want to activate it on a 4th device, just deactivate it from one of the original 3 first. ### Reached Your Activation Limit? If you've hit the 3-device limit, head to the [Octarine Dashboard](https://octarine.app/dashboard) or the LemonSqueezy Dashboard (linked in your purchase receipt) to deactivate the license from any device and free up a seat. You can also purchase additional seats from the [Octarine Dashboard](https://octarine.app/dashboard) to expand beyond the default 3-device limit. #### Quick Answers ### Is Octarine Pro a subscription? No. Octarine Pro is a one-time purchase with no recurring subscription fee. ### How many devices can use one Pro license? A Pro license can be active on 3 devices at the same time. ### How do I move my Pro license to another device? Deactivate the license from one existing device in `Settings -> Pro`, the Octarine Dashboard, or the LemonSqueezy dashboard link from your order email, then activate it on the new device. -------------------------------------------------------------------------------- title: "Workspaces" description: "Managing separate work contexts and note collections" source: "https://docs.octarine.app/core-concepts/workspaces" -------------------------------------------------------------------------------- # Workspaces ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/workspaces.png) A workspace is a folder on your device that holds all your notes, templates, attachments, and settings. Create as many as you need — useful for keeping work and personal content separate. When you first open Octarine, you'll be prompted to create a workspace before you can start using the app. ## Creating a Workspace Click the Workspace Switcher (your workspace name) in the top-left corner and select **Create Workspace**. You'll see three options: ### Create New Creates a brand new, empty folder at the location you choose. The workspace name you enter becomes the folder name — so if you name it "Work Notes" and pick your Documents folder, you'll end up with a `Documents/Work Notes` folder in Finder or Explorer. This is the simplest way to get started with a fresh set of notes. ### Open Existing Points Octarine at a folder you already have on your device. Nothing gets created or moved — Octarine simply starts treating that folder as a workspace. So if you select your existing `Documents/Meeting Notes` folder and name the workspace "Meetings", the folder stays as-is — "Meetings" is just the label you'll see inside Octarine. It doesn't rename the actual folder on disk. ### Import from Git Clones a Git repository and sets it up as a workspace. Octarine creates a new folder named after the repository — so if you clone `git@github.com:you/my-notes.git` into your Documents folder, you'll end up with a `Documents/my-notes` folder in Finder or Explorer. This is handy for pulling in notes you've already versioned or shared across devices. --- For all three options, you can pick an identifying color and optionally clone settings (like API keys and editor preferences) from an existing workspace by selecting one from the **Use settings from an existing workspace** dropdown. Git-related settings aren't carried over when cloning. ## Switching Workspaces - Click the Workspace Switcher and select a workspace, or - Use the Command Bar: `Cmd/Ctrl + K → Switch Workspace` ## Workspace Settings Each workspace has its own settings, so you can configure them independently. Change the workspace name or color anytime — the name change doesn't affect the actual folder name on disk. ## Deleting a Workspace Go to **Settings → Danger** and type the workspace name to confirm. This removes Octarine's settings and configurations for that workspace but doesn't delete your notes or the folder from your device. #### Quick Answers ### What is an Octarine workspace? A workspace is a folder on your device that contains your notes, templates, attachments, and workspace settings. ### Can I open an existing notes folder as a workspace? Yes. Choose **Create Workspace**, turn on **Use an existing folder?**, and select the folder you already use for notes. ### Does deleting a workspace delete my notes? No. Deleting a workspace removes Octarine's settings for that workspace, but it does not delete the folder or notes from your device. -------------------------------------------------------------------------------- title: "Split panes & Tabs" description: "Open notes, graph view, and Ask Octarine in flexible tabs and split panes for a multi-document workspace." source: "https://docs.octarine.app/core-concepts/panes-and-tabs" -------------------------------------------------------------------------------- # Split panes & Tabs Nearly everything in Octarine is a tab. Notes, Graph View, and Ask Octarine all open as tabs instead of individual entities, enabling a flexible multi-document workspace with both horizontal and vertical split pane layouts. ### Tab Types and States Each tab in Octarine has specific properties that define its behavior: - **Focused tab**: The tab you're currently editing or interacting with. Only one tab can be focused at a time across all panes. Identified by an accent-colored border at the top - **Active tab**: Each pane has one active tab - the currently visible tab in that pane. Shows a grey border on top when not focused - **Dirty tab**: Temporary tabs opened from the file tree, calendar, or meta sidebar links. These tabs are replaced when opening another file the same way. Identified by italic title text and a dot beside the name - To make a dirty tab permanent: right-click and select **Protect from Replacement** or start typing in the editor - Tabs opened via `Cmd/Ctrl + P`, `Cmd/Ctrl + T`, doclinks, or **Open in new tab** are permanent by default ### Creating and Managing Panes Split your workspace to view multiple documents simultaneously: - **Horizontal split**: `Cmd/Ctrl + \` - Splits the current tab horizontally - **Vertical split**: `Cmd/Ctrl + Shift + \` - Splits the current tab vertically - **Move tabs between panes**: - Drag tabs directly from one pane to another - Right-click a tab and use **Split** (duplicates to new pane) or **Move** (transfers between panes) - **Pane navigation**: Each pane includes Back/Forward buttons that maintain a history of viewed tabs ### Tab Operations Working with tabs within each pane: - **New tab**: `Cmd/Ctrl + T` - Opens a new empty tab in the current pane - **Cycle tabs**: `Cmd/Ctrl + Tab` - Cycles through all tabs in the current pane - **Jump to tab**: `Cmd/Ctrl + [1-9]` - Jumps directly to a numbered tab position - **Close tab**: `Cmd/Ctrl + W` - Closes the current tab - **Reorder tabs**: Drag tab headers horizontally within a pane to rearrange ### Navigation History Each pane maintains its own navigation history: - **Back button**: Returns to the previously viewed tab in that pane - **Forward button**: Moves forward through the navigation history - **Closed tab recovery**: Closing a tab and pressing Back will restore it > All the navigation options are also available via the `Cmd/Ctrl + K` bar. #### Quick Answers ### Does Octarine support split panes? Yes. Octarine supports horizontal and vertical split panes so you can view and edit multiple notes or app views side by side. ### What is a dirty tab? A dirty tab is a temporary tab opened from places like the file tree, calendar, or meta sidebar. It gets replaced when you open another file the same way unless you protect it or start editing. -------------------------------------------------------------------------------- title: "Storing Data" description: "How Octarine interacts and stores data for settings and notes" source: "https://docs.octarine.app/core-concepts/storing-data" -------------------------------------------------------------------------------- # Storing Data Octarine stores your notes as Markdown-formatted plain text files in a workspace. A workspace is a folder on your file system. Octarine continously *watches* your workspace folder for an external changes, and makes instant reflection of it in the app. Given that you are working with folder and plain text files, these can be edited by any external text editor of your choosing. A workspace folder can be created anywhere on your device, including in cloud drives like iCloud, Dropbox local folders. ### iCloud Workspaces After Restart If an iCloud-backed workspace is remembered by Octarine but you can't see your notes in the file tree after restarting your device, iCloud or macOS may not have made the folder readable yet. This can happen when iCloud Drive is still downloading the workspace, or when macOS privacy permissions temporarily block Octarine from reading the workspace folder and its `.octarine` metadata. Try the following: - Wait a minute for iCloud Drive to finish syncing, then reopen the workspace. - In Finder, right-click the workspace folder and choose **Download Now** if it is available. - On macOS, open **System Settings → Privacy & Security → Full Disk Access**, add Octarine, and turn it on. - Fully quit Octarine and open it again. - If the workspace still looks stale, run `Cmd + K → Refresh Workspace` to re-index it. ### Config File - Octarine stores major settings in a global `.store.dat` file and follows a `json` format. | OS | Path | | --- | --- | | Mac | \~/Library/Application Support/Octarine | | Windows | C:\\Users\\username\\AppData\\Roaming\\Octarine.app | | Linux | \~/.config/Octarine.app | - These hold information about what workspaces are currently created and at what locations, and their settings — themes, editor, git and more - These also hold information about your pro license keys, and AI provider keys. > This is never synced with any service (GitSync, iCloud) or never reaches any servers. This is kept completely on device for security purposes. > > Please ensure you don’t make any changes or delete this without creating a backup, since deletion could have irreversible changes. ### IndexedDB - Octarine remains fast by loading all data about the workspace into different tables in an indexeddb in the browser engine that powers the app. - These included folder structure, metadata about notes, pinned/locked notes, ask octarine and writing assistant chats. - The metadata and files are kept in sync with the local file system to prevent any mismatches. > You can refresh a database by using `Cmd + K → Refresh Workspace` to force the database to re-index everything. > > Note: Ask Octarine and Writing Assistant history as well as Recently Viewed will be wiped clean and can’t be recovered when this is done. Be careful. #### Quick Answers ### Where does Octarine store notes? Octarine stores notes as plain Markdown files inside the workspace folder you choose on your device. ### Does Octarine upload my notes? No. Octarine does not upload your notes to its own servers. Sync and backup only happen if you place a workspace in a service like iCloud, Dropbox, OneDrive, Syncthing, or Git Sync. ### Can I edit Octarine notes outside the app? Yes. Because notes are plain text Markdown files, you can edit them with another text editor. Octarine watches the workspace folder and reflects file changes in the app. -------------------------------------------------------------------------------- title: "Workspace Search" description: "Quickly find and navigate to any note in your workspace" source: "https://docs.octarine.app/core-concepts/workspace-search" -------------------------------------------------------------------------------- # Workspace Search Workspace Search helps you find notes instantly by searching through titles, content, and tags. Located at the top of the sidebar, just below the workspace selector, it's always within reach. ### Opening Search - **Click** the search field in the sidebar, or - **Press** `Cmd/Ctrl + Shift + F` from anywhere ### How It Works As you type, results appear in real time. Click any result to open the note—Octarine will automatically launch in-file search with your query, highlighting all matches within the document. **Search options:** - **Full-text search** — Search across note titles and content - **Tag search** — Use hashtags to filter by tags (e.g., `#project`) - **Regex** — Enable regular expressions for advanced pattern matching - **Match word** — Restrict results to complete word matches (compatible with regex) - **Match case** — Enable case-sensitive matching (compatible with regex) - **Search in** — Narrow your search to specific areas like Daily Desk or Templates ### Understanding Results Results display the note title with matching terms highlighted, along with a content preview showing where your query appears. Opening a result preserves your search filters, so in-file search continues with the same criteria. **Keyboard navigation:** - `↑` `↓` — Move through results - `Enter` — Open selected note - `Escape` — Clear search and dismiss results #### Quick Answers ### How do I search all notes in Octarine? Use Workspace Search from the sidebar, or press `Cmd/Ctrl + Shift + F` from anywhere. ### Can Octarine search by tags? Yes. Use hashtags such as `#project` in Workspace Search to filter by tags. ### Does Workspace Search support regex? Yes. Enable the regex option for advanced search patterns. -------------------------------------------------------------------------------- title: "Graph" description: "Visualise your notes and their connections in a 2d graph" source: "https://docs.octarine.app/core-concepts/graph" -------------------------------------------------------------------------------- # Graph The graph view turns your workspace into an interactive map of ideas. Every note becomes a node, and the links between them become visible connections—giving you a bird's-eye view of how your thoughts relate to each other. ### The Basics Think of the graph as a constellation of your notes. Each dot represents a markdown file, and the lines between them show where notes reference each other through wikilinks. The graph includes three types of nodes: regular notes, daily/weekly entries, and tags—each visually distinct so you can tell them apart at a glance. What makes it interactive is the physics simulation running behind the scenes. Connected notes naturally cluster together, and you can drag nodes around to reorganize things however you like (though it won't save your layout—it's just for exploring during that session). ### Navigating the Graph Using the graph is intuitive. Click any node to open that note in a new tab. Hover over a node to see its title and watch its immediate connections light up. You can zoom in to focus on a specific cluster of related notes, or zoom out to see your entire knowledge network at once. The graph uses force-directed layout algorithms to position everything automatically. Notes that reference each other pull closer together, while unrelated notes drift apart. It's like watching your ideas organize themselves. ### Searching the Graph Need to find a specific note or connection quickly? Use the graph search feature by clicking the magnifying glass icon at the top right or pressing `Cmd/Ctrl + F`. When you search, matching notes are highlighted and zoomed into view while other nodes dim into the background. If your search finds exactly one match, the graph will zoom in maximally on that note, making it easy to see its immediate connections and context. ### Understanding Connections The graph reveals relationships you might not notice otherwise: Solid lines connect notes that link to each other directly through `[[internal links]]`. Notes that share common tags cluster around those tags, showing thematic relationships. And isolated nodes—those lonely dots floating by themselves—are orphan notes that haven't been linked to anything yet. They're a good reminder of content that might need connecting. The more two notes reference each other, the stronger their visual connection tends to be. It's a simple but powerful way to see which ideas are most tightly woven together in your workspace. #### Quick Answers ### What does Octarine's graph view show? Graph view shows notes, daily or weekly entries, and tags as nodes, with links between notes shown as connections. ### Can I open notes from the graph? Yes. Click a graph node to open that note in a new tab. ### Can I search inside the graph view? Yes. Use graph search from the magnifying glass icon or press `Cmd/Ctrl + F` while using the graph. -------------------------------------------------------------------------------- title: "Basics" description: "Core editing features and functionality" source: "https://docs.octarine.app/editor/basics" -------------------------------------------------------------------------------- # Basics The editor is where you'll spend most of your time in Octarine, transforming thoughts into well-structured markdown documents. With its WYSIWYG approach, you see your formatted text immediately without dealing with raw markdown syntax or jumpy live previews. All content is stored in markdown, and supports all markdown shortcuts. Please learn more about markdown [here](https://www.markdownguide.org/basic-syntax/). > Octarine is built using Tiptap and Prosemirror. It stores data as markdown in content, but it isn't a markdown editor. Rendered data will always be rich text with no way to switch to a markdown view. ### Writing and Editing Octarine's editor operates like any modern word processor—simply click and start typing. The cursor position, text selection, and editing behaviors work exactly as you'd expect from standard text editing applications. - **Auto-save**: Changes are saved automatically as you type, ensuring your work is never lost. - **Undo/Redo**: Press `Cmd/Ctrl + Z` to undo and `Cmd/Ctrl + Shift + Z` to redo changes. - **Find and Replace**: Use `Cmd/Ctrl + F` to search within the current note. > Markdown doesn't have a concept of blank lines. While Octarine may show multiple blank lines on return/enter being pressed, they aren't stored as such due to markdown rules, and will be reverted on a refresh. This is an unfortunate limitation of the app. Enter/Return creates a new paragraph, with `Shift+Enter` to create a break line (can only have one at a time). ### Inserting Content Beyond regular text, you can insert various content types: - **Images**: Drag and drop image files directly into the editor, or paste from clipboard - **Code blocks**: Insert formatted code blocks with syntax highlighting for over 70 languages - **Tables**: Create structured data tables with automatic cell navigation - **Horizontal rules**: Insert dividers with `---` on a new line > All editing operations maintain proper markdown structure behind the scenes, ensuring your notes remain portable and compatible with other markdown tools. -------------------------------------------------------------------------------- title: "Formatting" description: "Markdown syntax and text formatting options" source: "https://docs.octarine.app/editor/formatting" -------------------------------------------------------------------------------- # Formatting Octarine gives you several ways to format your text. If you're a Markdown pro, you can use the syntax directly. But if you prefer a more visual approach, there are shortcuts built right in. **Quick ways to format:** - **Slash Command** — Press `/` to open a searchable dropdown with all formatting options, then hit `Enter` to apply what you need - **Bubble Menu** — Select any text and a floating toolbar will appear right above it, giving you quick access to common formatting options > You can customize the default highlight color in **Settings → Editor → Default Highlight Color**. This sets the color applied when you use the `Cmd/Ctrl + Shift + H` keyboard shortcut. Here's a complete reference for all the Markdown syntax Octarine supports, along with keyboard shortcuts to speed things up: | Formatting Type | Markdown Syntax | Keyboard Shortcut | | --- | --- | --- | | Heading 1 | `# text` | Cmd/Ctrl + Option/Alt + 1 | | Heading 2 | `## text` | Cmd/Ctrl + Option/Alt + 2 | | Heading 3 | `### text` | Cmd/Ctrl + Option/Alt + 3 | | Bold | `**text**` | Cmd/Ctrl + B | | Italics | `*text*` | Cmd/Ctrl + I | | Quote | `> text` | None | | Inline Code | `` `text` `` | Cmd/Ctrl + E | | Strikethrough | `~~text~~` | Cmd/Ctrl + Shift + S | | Underline | `~text~` | Cmd/Ctrl + U | | Bullet List | `- text` or `* text` | Cmd/Ctrl + Shift + 8 | | Numbered List | `1. text` | Cmd/Ctrl + Shift + 7 | | Task List | `[] text` | Cmd/Ctrl + Shift + 9 | | Paragraph | `text` | Cmd/Ctrl + Shift + 0 | | Web Link* | `[Link](http://example.com)` | None | | Web Image* | `![Image](http://example.com/image.png)` | None | | Codeblock | ```` ``` text ```` | Cmd/Ctrl + Option/Alt + C | | Divider | `—-` | None | -------------------------------------------------------------------------------- title: "Doclinks" description: "Connecting notes and attachments with wikilinks" source: "https://docs.octarine.app/editor/doclinks" -------------------------------------------------------------------------------- # Doclinks Doclinks (also known as wikilinks) are how you connect notes and attachments in Octarine. They're the foundation for building a web of interconnected notes—and the only way for notes to appear in the [Graph View](https://docs.octarine.app/docs/core-concepts/graph). ## Creating Doclinks There are a couple of ways to create a doclink: 1. **Type `[[` and `]]`** — Wrap any text with double brackets to create a link directly 2. **Use the search command** — Type `[[` to open a search that finds notes, attachments, and dates as you type 3. **Drag and drop** — Drag any note from the file tree directly into the editor to create a wikilink at the cursor position The search command finds: - **Note titles and folder names** — Link to any note in your workspace - **Media attachments and external files** — Embed images, videos, and other files using the same `[[filename]]` syntax - **Natural language dates** — Type something like `Dec5` to find or create a Daily Desk note for December 5, 2025 Use arrow keys to navigate results and press Enter to confirm your selection. ## How Doclinks Appear Note doclinks appear as clickable links that show a preview when you hover over them. Media attachments are embedded directly in your note. By default, doclinks display the full path (excluding the workspace root). To show only the shortest unique name, change this in `Settings → Editor → Linked Note Display`. ## Creating Notes from Doclinks The `[[` command lets you create new notes on the fly. If nothing matches what you've typed, you'll see: - **Create a note in this folder** — Creates the note alongside your current note - **Create a note at root** — Creates the note at the workspace root This lets you build out your notes organically without breaking your flow. ## Automatic Link Updates When you rename or move a file, Octarine automatically updates all incoming and outgoing doclinks. You'll never have broken links. ## Markdown Syntax Under the hood, doclinks use standard wikilink syntax: - Note doclinks: `[[Documentation/Formatting]]` - Attachments (with file extensions): `[[Screenshot 23.05.png]]` -------------------------------------------------------------------------------- title: "Bubble Menu" description: "Quick formatting toolbar when selecting text." source: "https://docs.octarine.app/editor/bubble-menu" -------------------------------------------------------------------------------- # Bubble Menu ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/bubble-menu.png) The bubble menu is your quick-access formatting toolbar that appears when you select text. It puts the most common formatting options right at your fingertips. ### How to Use the Bubble Menu 1. **Select any text** in your note by clicking and dragging 2. The bubble menu automatically appears above your selection 3. Click any button to apply formatting 4. The menu disappears when you click elsewhere ### Available Formatting Options The bubble menu includes these formatting tools: - All Basic formatting tools - **Highlight** - Apply background highlighting - This is a dropdown that allows you to set a color for the highlight. Clicking on the same color on a highlighted text, de-highlights it. - **Add to Chat** - Adds the selected text to the Writing Assistant as context. - **Create linked note from selection** - Creates a note with the text selected (if it doesn’t contain invalid characters) and auto links it. ### When the Bubble Menu Won't Appear The bubble menu doesn't appear when: - You're in a code block - You're editing a table cell > Some bubble menu buttons will be hidden when under bullet list, numbered list or task lists like - Header, Callout, Codeblock, Quote since those can’t be assigned to a list item. -------------------------------------------------------------------------------- title: "Attachments" description: "Managing images, videos, and other media files" source: "https://docs.octarine.app/editor/attachments" -------------------------------------------------------------------------------- # Attachments Octarine makes it easy to enrich your notes with images and videos. Whether you're documenting a project, creating a visual guide, or just adding some personality to your notes, attachments work seamlessly. > All your media attachments are kept organized in a `.attachments` folder inside your workspace. If you don't see it in Finder, you may need to enable viewing hidden folders. ### What You Can Attach Octarine supports common image formats like `png`, `jpg`, `jpeg`, `gif`, `svg`, and `webp`, plus video formats including `mp4`, `webm`, and `mov`. Pretty much anything you'd expect to work does. You can also embed web links. Regular URLs become preview cards, direct image URLs become images, and YouTube links can become playable embeds. ### Adding Attachments to Your Notes There are a few ways to get media into your notes, depending on what feels most natural: **Adding a new attachment:** - Type `/` and select "Insert Media" to open a file picker and choose an image or video from your computer - Or just drag and drop a file directly from Finder into your note—it'll be added automatically **Reusing an existing attachment:** - Type `[[` to see a list of all attachments already in your workspace, then pick the one you need - You can also drag attachments from the attachments popover directly into your note > Want to resize an attachment? Just grab the resize handle and adjust it to fit. The width gets stored right in the wikilink format, like this: `[[Image.png|450]]`, where `450` is the width in pixels. ### Link and YouTube Embeds If you have a normal external link in a note, you can turn it into an embed from the link popover. - Click into the link, then choose **Embed link**. - Or `Option/Alt + click` the link while editing. Octarine handles different links in the way that makes the most sense: - **Regular links** become preview cards with the title, domain, description, and image when that metadata is available. - **Direct image links** become embedded images. - **YouTube links** from `youtube.com`, `m.youtube.com`, or `youtu.be` become YouTube embeds. Octarine also understands YouTube iframe embeds when you paste or import them. Embeds stay portable in Markdown. Link previews are saved as normal Markdown links with Octarine metadata, and YouTube embeds are saved as iframe markup plus metadata. If you ever want the plain link back, open the embed menu and choose **Convert to text link**. ### Managing Unused Attachments Over time, you might accumulate attachments that are no longer referenced in any of your notes. Octarine makes it easy to clean these up. Open the attachments popover and look for files that aren't being used. You can delete any unused attachments with a single click, keeping your workspace tidy and freeing up storage space. -------------------------------------------------------------------------------- title: "Video Annotation" description: "Add timestamped notes to videos and jump back to the exact moment later." source: "https://docs.octarine.app/editor/video-annotation" -------------------------------------------------------------------------------- # Video Annotation Video Annotation lets you take notes against a specific moment in a video. It is built for lectures, demos, research calls, tutorials, design reviews, and any other video where "somewhere around the middle" is not good enough. > Video Annotation requires a Pro license. ## Start With A Video Add a video to a note the same way you add other media: drag it into the editor, use **Insert Media**, or reuse an existing attachment with `[[`. Octarine supports common video formats such as `mp4`, `webm`, and `mov`. See [Attachments](https://docs.octarine.app/editor/attachments) for the broader media workflow. ## Add An Annotation Play the video until you reach the moment you want to capture, then click the annotation button in the video controls. Write the note you want attached to that moment and press **Insert**. Octarine creates a bullet below the video with a clickable timestamp followed by your annotation. For example: ```markdown - [10:24](oct-video://ts?file=lecture.mp4&t=624) Important explanation of the pricing model - [18:02](oct-video://ts?file=lecture.mp4&t=1082) Compare this with the older onboarding flow ``` In the editor, the timestamp is shown as a compact clickable marker. Click it and Octarine seeks the matching video back to that moment. ## Timestamp Markers Sometimes you only need the timestamp, not a full note. Use **Insert timestamp marker** from the video controls to add the current time as a bullet item. This is useful when you are watching quickly and want to mark places to revisit before writing proper notes. ## Copy A Timestamp Use **Copy timestamp** when you want to paste a timestamp link somewhere else in the same note or another note. The copied link keeps the video filename and time together, so it can still jump back to the right moment as long as the referenced video is available in the workspace. ## Shortcuts When the video controls are focused, use: - `N` to add an annotation. - `M` to insert a timestamp marker. - `C` to copy the current timestamp. ## Good Uses Video Annotation works especially well for: - Lecture notes where each idea needs to link back to the source. - User interviews where quotes, reactions, and questions happen at exact moments. - Product demos where you want to note bugs or UX details as they appear. - Design critique where feedback belongs to a specific frame or section. - Tutorial notes where you want to replay a step without scrubbing around. Keep annotations short while watching. You can always expand them later, and the timestamp will still take you back to the moment that prompted the note. -------------------------------------------------------------------------------- title: "Tables" description: "Create and manage tables with powerful editing tools" source: "https://docs.octarine.app/editor/tables" -------------------------------------------------------------------------------- # Tables Tables in Octarine aren't just static grids—they support rich formatting and come with a full toolbox for organizing and manipulating data without the hassle of manual copy-pasting. ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/doc_tables.png) ### Creating Tables You can create a table the traditional way with Markdown syntax: ```markdown | Header 1 | Header 2 | Header 3 | | --- | --- | --- | | Cell 1 | Cell 2 | Cell 3 | | Cell 4 | Cell 5 | Cell 6 | ``` Or just press `/` and type "table" to insert one instantly. ### Table Toolbox Click on any table and the toolbox pops up, giving you quick access to everything you need: **Row operations** let you insert rows above or below the current one, move rows up or down, copy a row, or delete it entirely. **Column operations** work the same way—insert columns to the left or right, move them around, copy them, or delete them. And if you need to work with the whole table, you can copy it or delete it in one go. ### Resizing Columns Drag the edge between two columns to resize a table. Octarine keeps cells readable by enforcing a minimum column width of 100px. Column widths are saved in the Markdown file as an Octarine metadata comment directly above the table: ```markdown | Name | Notes | Status | | --- | --- | --- | | Alpha | Follow up next week | Open | ``` Each number maps to a column width in pixels. A `0` means that column is still using the default width. Octarine hides this comment in the editor and reapplies the widths when the note is opened again. The table itself remains normal Markdown, so it still works in other Markdown apps. Apps that do not understand Octarine's metadata will simply ignore the comment and show the table with their default column sizing. ### Keyboard Shortcuts If you prefer keeping your hands on the keyboard, here are the shortcuts: - `Option/Alt + Up Arrow` — Move the current row up - `Option/Alt + Down Arrow` — Move the current row down - `Option/Alt + Left Arrow` — Move the current column left - `Option/Alt + Right Arrow` — Move the current column right ### A Few Tips Tables support all the usual formatting—bold, italics, links, inline code, whatever you need. The toolbox makes restructuring data quick and painless, and the keyboard shortcuts let you reorganize things without breaking your flow. -------------------------------------------------------------------------------- title: "Code Blocks" description: "Syntax-highlighted code blocks with advanced features" source: "https://docs.octarine.app/editor/code-blocks" -------------------------------------------------------------------------------- # Code Blocks Code blocks let you include formatted code snippets in your notes with syntax highlighting. Octarine supports over 300 programming languages and provides helpful editing features to make working with code easier. ### Creating a Code Block There are several ways to insert a code block: - Type `/` and select "Code Block" from the menu - Use the markdown syntax: type three backticks ` ``` `, press Enter, then close with three more backticks - Use the keyboard shortcut: `Cmd/Ctrl + Option/Alt + C` ### Selecting a Language After creating a code block, click the language selector at the top-left corner to choose from over 300+ supported languages. The selector is searchable, so you can quickly find the language you need. Once you select a language, syntax highlighting is applied automatically to make your code more readable. ### Editing Code Code blocks support helpful editing features: - **Tab/Shift+Tab** — Indent and outdent lines of code - **Copy button** — Click the copy icon to copy the entire code block to your clipboard ### Formatting Unlike the rest of your note, code blocks preserve: - Exact spacing and indentation - Multiple consecutive spaces - Line breaks exactly as typed This ensures your code appears exactly as you write it, without any automatic formatting changes. -------------------------------------------------------------------------------- title: "Mermaid" description: "Generate diagrams via code" source: "https://docs.octarine.app/editor/mermaid" -------------------------------------------------------------------------------- # Mermaid Need to visualize a process or create a diagram? Mermaid lets you do that with just text—no design tools required. Write a simple description, and Mermaid turns it into a professional-looking diagram right in your note. ## Creating a Mermaid Diagram There are a few ways to add one: Type `/mermaid` and press Enter, or create a code block and set the language to `mermaid`. You can also use triple backticks with `mermaid` as the language if you're writing in Markdown. And if you want a quick start with an example, just press `Cmd/Ctrl + Shift + M`. ## Example Here's a basic flowchart to show you how it works: ```mermaid graph TD A[Start] --> B{Decision} B -->|Yes| C[Do this] B -->|No| D[Do that] C --> E[End] D --> E ``` That's it—Mermaid handles the rest and renders it for you. ## Learn More Mermaid supports flowcharts, sequence diagrams, class diagrams, and a lot more. For the full syntax and advanced features, check out the official [Mermaid documentation](https://mermaid.js.org/intro/). -------------------------------------------------------------------------------- title: "LaTeX" description: "Support for mathematical functions" source: "https://docs.octarine.app/editor/latex" -------------------------------------------------------------------------------- # LaTeX Octarine supports LaTeX for mathematical notation and scientific formulas, rendering them beautifully inline with your text. Perfect for academic writing, technical documentation, and mathematical notes. > By default latex rendering is turned OFF since it's perf intensive. To turn on, head over to `Settings -> Editor` and toggle `Render Math Equations` on. ### Inline Math To include math within a line of text, just wrap your formula in single dollar signs. For example, `$E = mc^2$` renders as Einstein's famous equation inline. More complex expressions work too—something like `$\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}$` will render beautifully right alongside your writing. ### Block Math For standalone equations that deserve their own line, use a math block. There are several ways to insert one: - **Slash command**: Type `/` and search for "Math Block" - **Keyboard shortcut**: `Cmd+Shift+M` (Mac) or `Ctrl+Shift+M` (Windows/Linux) - **Paste**: Paste text wrapped in double dollar signs (`$$...$$`) and it will automatically convert to a math block Once inserted, type your LaTeX directly into the block. The equation renders in display mode, centered on its own line—great for larger expressions like: ``` $$ \int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2} $$ ``` **Editing a math block:** - **Double-click** the rendered equation to edit it - Press **Enter** when the block is selected to enter edit mode - Press **Shift+Enter** or **Escape** to finish editing - Empty math blocks are automatically removed when you exit edit mode ### Quick Reference Here are some of the most commonly used LaTeX symbols and how to write them: **Basic notation:** - Superscript: `x^2` → x² - Subscript: `x_1` → x₁ - Fractions: `\frac{a}{b}` → a/b - Square root: `\sqrt{x}` → √x - Sum: `\sum_{i=1}^n` → Σ - Integral: `\int_a^b` → ∫ **Greek letters:** - `\alpha, \beta, \gamma` → α, β, γ - `\Delta, \Omega` → Δ, Ω - `\pi, \theta, \phi` → π, θ, φ **Mathematical operations:** - `\times` → × - `\div` → ÷ - `\pm` → ± - `\leq, \geq` → ≤, ≥ - `\neq` → ≠ - `\approx` → ≈ -------------------------------------------------------------------------------- title: "Callout" description: "Visual elements to draw attention to a blockquote." source: "https://docs.octarine.app/editor/callout" -------------------------------------------------------------------------------- # Callout Need to make something stand out? Callouts are visual blocks designed to highlight important information—whether it's a tip, a warning, or just a key point you want readers to notice. ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/callout.png) ### Creating a Callout Adding one is quick. Just type `/callout` and pick the type you want from the list. Or, if you've already got text selected, click the callout icon in the Bubble Menu and it'll wrap your text for you. ### Types of Callouts Octarine gives you five callout types, each with its own icon and color to match the vibe: - **Info** `![INFO]` - **Warning** `![WARNING]` - **Error** `![ERROR]` - **Success** `![SUCCESS]` - **Tip** `![TIP]` You can change the type anytime using the dropdown that appears when you click on the callout. ### Syntax Here's what it looks like under the hood: ```plaintext > [!TIP] > You can nest other formatting inside callouts, including lists, links, and even code blocks. ``` Pretty simple—just a blockquote with a special tag at the top. -------------------------------------------------------------------------------- title: "Heading Font" description: "Customise fonts for H1-H6" source: "https://docs.octarine.app/editor/heading-font" -------------------------------------------------------------------------------- # Heading Font Heading Font lets you customize the typeface used for all headings (H1-H6) in your workspace, creating visual hierarchy and giving your documents a distinctive look. You can choose a different font from your editor text or keep them matching. ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/heading_font.png) ## Changing Your Heading Font Here's how to customize your heading font: 1. Open **Settings** 2. Go to the **Editor** tab 3. Find the **Heading font** dropdown 4. Pick the font you like Once you've selected a font, you can also adjust its **Font Weight** from the same settings tab. Depending on the font you've chosen, you'll see options like Light, Regular, Medium, Semibold, Bold, and Black. Not all fonts support every weight, so the available options will vary based on your selection. ## Available Font Options Octarine gives you plenty of options: - **Same as editor font** — Keep headings and body text consistent - **Bundled fonts** — Choose from Inter, Karla, iAQuattro, Uncut, Roboto Mono, Space Mono, Hand, or Avenir - **System fonts** — Use any font installed on your computer The dropdown shows a preview of each font in its actual typeface, so you can see exactly what you're getting before you commit. ## How It Works Once you've chosen a heading font, it applies to all headings (H1 through H6) across your entire workspace. Your body text stays the same, so you can create clear visual hierarchy between headings and content. > Heading font is a Pro feature. Want a classic look? Try pairing a serif heading font with a sans-serif body—it's a timeless combination. -------------------------------------------------------------------------------- title: "Collapsible Headings" description: "Collapse and expand sections to navigate long notes" source: "https://docs.octarine.app/editor/collapsible-headings" -------------------------------------------------------------------------------- # Collapsible Headings Long notes with multiple sections can be easier to navigate when you can collapse content under headings. Octarine lets you fold sections away to focus on what matters. ### How to Collapse Headings Click the collapse icon (arrow) that appears next to any heading to hide or show the content beneath it: - **Collapse** — Click the down arrow (▼) to hide all content under that heading - **Expand** — Click the right arrow (▶) to reveal the content again - The collapsed state is saved with the note and persists across sessions This works with all heading levels (H1 through H6). When you collapse a heading, everything beneath it—including subheadings—gets hidden until you expand it again. ### Hierarchical Collapsing Collapsing follows the heading hierarchy, so when you collapse a higher-level heading, all lower-level headings beneath it are also hidden: - If you collapse an **H1**, all H2-H6 headings under it will be collapsed until the next H1 - If you collapse an **H2**, all H3-H6 headings under it will be collapsed until the next H1 or H2 - If you collapse an **H3**, all H4-H6 headings under it will be collapsed until the next H1, H2, or H3 This makes it easy to hide entire sections and subsections at once. ### Keyboard Shortcuts For faster navigation without using the mouse: - `Option/Alt + Cmd/Ctrl + [` — Collapse the current heading section - `Option/Alt + Cmd/Ctrl + ]` — Expand the current heading section ### When to Use This Collapsible headings are particularly useful when: - Working with long documents that contain many sections - Focusing on one part of a note while editing - Getting an overview of a note's structure without scrolling - Presenting or reviewing documents section by section - Temporarily hiding reference material while writing ### Navigation with Collapsed Headings Even when sections are collapsed, you can still: - Use the [Outline Navigation](https://docs.octarine.app/note-management/outline-navigation) command to jump to any heading - Search for text within collapsed sections—Octarine will expand them automatically when showing results - View the full structure in the [Meta Sidebar](https://docs.octarine.app/note-management/meta-sidebar#outline) outline tab -------------------------------------------------------------------------------- title: "Text Color" description: "Apply a range of colors to paragraphs and headers" source: "https://docs.octarine.app/editor/text-color" -------------------------------------------------------------------------------- # Text Color Text Color allows you to apply vibrant colors to your text, making important words or phrases stand out in your documents. This is perfect for highlighting key terms, creating visual emphasis, or organizing information by color. ## Creating Colored Text You can apply color to your text in two ways: 1. **Bubble Menu**: Highlight the text you want to color, click the palette icon (🎨) in the Bubble Menu, and pick a color 2. **Markdown syntax**: Type `~🔴your text~` and replace the emoji with whichever color you want ## Available Colors Octarine gives you eight colors to work with: 🔴 | 🟠 | 🟡 | 🟢 | 🔵 | 🟣 | 🟤 | 🩷 Need to change a color? Just select the text and pick a different one from the palette dropdown. ## A Few Things to Know Text color doesn't play nicely with underline, highlight, or strikethrough—if you apply one of these, the color will be removed, and vice versa. But you can still combine colored text with **bold**, *italic*, and headers without any issues. > Text color is a Pro feature, and works great when combined with bold or italic formatting for extra visual impact. -------------------------------------------------------------------------------- title: "Focus Mode" description: "Write distraction-free with Focus Mode" source: "https://docs.octarine.app/editor/focus-mode" -------------------------------------------------------------------------------- # Focus Mode Focus Mode helps you concentrate on your writing by opening a dedicated, clean dialog that removes visual clutter. It's perfect for when you need to get into deep work without distractions from the rest of the interface. > Focus Mode is only available to users on the Pro License. ### Activating Focus Mode Enter Focus Mode by pressing `Cmd/Ctrl + Shift + L`. When you do, your current note opens in a clean, dedicated dialog. The sidebars stay in their current state—if they were open before, they'll remain open; if they were closed, they stay closed. To exit, simply close the dialog or press the shortcut again. Any edits you make are instantly synced back to the main editor. ### Dimming Options Focus Mode offers two dimming styles that you can configure in `Settings → Preferences`: **Sentence Mode** — Dims everything except the current sentence you're working on. This helps you focus on one thought at a time, making it easier to spot typos and refine your ideas line by line. **None** — No dimming at all. The entire note remains visible, giving you the benefits of a dedicated writing space without any visual restrictions. The dimming preference applies whenever you use Focus Mode, so pick the style that helps you concentrate best. Sentence mode has also been optimized for better performance, so it should feel smooth even in longer notes. ### What Works in Focus Mode Focus Mode is fully functional—you can use all the usual editing features: - Type `/` to open the command bar and insert blocks, media, or formatting - Type `[[` to create wikilinks and connect your notes - All keyboard shortcuts work normally - Your changes sync immediately with the main editor Focus Mode is designed to feel just like writing in the main editor, but with fewer distractions pulling your attention away. -------------------------------------------------------------------------------- title: "File Tree" description: "Hierarchical navigation for your notes and folders" source: "https://docs.octarine.app/organization/tree" -------------------------------------------------------------------------------- # File Tree ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/file_tree.png) The file tree is your primary navigation tool in Octarine, providing a hierarchical view of all notes and folders in your workspace. It offers quick access to your content while maintaining a clean, organized structure that mirrors your local file system. ### The Basics The file tree displays your workspace's folder structure in the left sidebar, showing all markdown files and directories. Since Octarine stores notes as standard markdown files on your local system, the file tree reflects the actual file organization on your disk. - **Real-time synchronization**: The file tree automatically updates when files are added, modified, or moved—whether through Octarine or external tools like Finder/Explorer or even other apps. - **Hierarchical organization**: Folders can be nested infinitely, allowing complex organizational structures - **Visual indicators**: Folders have icons attached to them, and a count showing the total amount of `notes` inside them (this includes notes in nested folders). ### Navigating the waters Navigate through your notes using these methods: - **Click** any note to open it in the editor - **Click** folder arrows to expand or collapse directories - Press `Cmd/Ctrl + Shift + E` to focus the tree, and then use: - **Use arrow keys** to move through the tree when focused - `Space` to open a note or expand/collapse a folder. - **Press** `Cmd/Ctrl + P` to open quick file navigation, which instantly updates the tree and centers on your selected note - The default sorting mechanism used is by `Filename (A - Z)` with directories always on top followed by notes. - You can change this by clicking on the sort icon in the tree's quick actions and choose one of the other sort methods. This is stored in the workspace configuration. > Sorting by Modified date is the most performance intensive sort since it needs to keep watching for changes continously in the file tree to move notes/folders up and down. Suggested to use it only if you want it really, and can bear with Octarine eating a few more resources (not much) than it does. ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/context_menu.png) ### Creating Content The file tree toolbar provides quick actions for content creation: - **New Note button**: Creates a new markdown note called `Untitled` at the root of your workspace by default. - Hold down `Cmd/Ctrl` while clicking to create the note in the same folder as your currently open note instead. > Note: If an existing note named *Untitled* already exists in the folder, a number suffix is added starting with `1` and checking until it finds a unique name — `Untitled 1` is created as the new note. - **New Folder button**: Creates a new directory called `New Folder` at the root of your workspace by default. - Hold down `Cmd/Ctrl` while clicking to create the folder in the same folder as your currently open note instead. - Same naming rules apply as new notes—if `New Folder` exists, it adds a number suffix. - **Keyboard Shortcuts**: Press `Cmd/Ctrl + N` for new note and `Cmd/Ctrl + Shift + N` for new folder. - **Drag from Finder**: You can drag markdown files directly from Finder/Explorer onto the tree to add them to your workspace. Hovering over a folder while dragging will add the file to that folder. - Quickly duplicate an existing note via the context menu or by pressing `Cmd/Ctrl + C` when the note is focused in the tree. - This creates a `_copy_` note in the same folder with the same content. > You can create a note/folder explicitly at root or in the current folder via the `CMD/Ctrl + K` bar as well. ### Moving Content - Hold a note/folder to drag it onto another folder to move it there. - Potential drop point have their backgrounds changed to the accent color to help identify the drop area. - If a potential drop area folder is collapsed, it's expanded after 200ms of you staying over the folder to help you drop it inside nested folders. - If you drop a note/folder over another note, then the drop point note's parent folder is assumed to be the target destination. ### Deleting Content - Delete a note/folder by either the context menu or pressing `Cmd/Ctrl + Backspace` when the content is focused in the tree. - This would show a confirmation dialog explaining you that there's no recovery for the deleted content (it doesn't go to the Bin/Recycle Bin, but rather is permanently deleted). ### Troubleshooting - If you ever notice that the file tree is misbehaving or not in line with the latest finder/explorer, and restarting the app doesn't solve it, you can trigger a hard refresh by pressing the `Refresh File Tree` icon in the tree's quick actions. - This will rebuild the database index with the latest finder details and ensure correctness. #### Quick Answers ### What does the File Tree show in Octarine? The File Tree shows the real folder and Markdown file structure of your workspace. ### Can I create notes and folders from the File Tree? Yes. Use the File Tree toolbar, context menu, or shortcuts like `Cmd/Ctrl + N` for notes and `Cmd/Ctrl + Shift + N` for folders. ### What should I do if the File Tree looks out of sync? Use the **Refresh File Tree** action to rebuild the database index from the latest files on disk. -------------------------------------------------------------------------------- title: "Tagging" description: "Organize and find notes with keywords" source: "https://docs.octarine.app/organization/tagging" -------------------------------------------------------------------------------- # Tagging Tags are keywords you attach to notes for quick filtering and discovery. They work across your entire workspace, making it easy to find related content no matter where it lives in your folder structure. ### Creating Tags Type `#` in the editor followed by your tag name. The tag command bar shows existing tags for quick selection, or just keep typing to create a new one. **Nested tags:** Use `/` to create hierarchies: - `#work` - `#work/projects` - `#work/projects/2024` When you create `#work/projects/2024`, Octarine automatically includes the parent tags `#work` and `#work/projects`—so you can filter by any level without creating separate tags. ### Using Tags Click any tag in the editor to search for it. This opens the search drawer with all notes containing that tag. ### Tags View Click the tag icon in the top-right corner to see all tags in your workspace. Each tag shows how many notes reference it. Click any tag to search for it across your workspace. #### Quick Answers ### How do I create a tag in Octarine? Type `#` in the editor followed by the tag name. Octarine shows existing tags as suggestions, or you can keep typing to create a new one. ### Does Octarine support nested tags? Yes. Use `/` in a tag, such as `#work/projects`, to create nested tag hierarchies. ### How do I find notes with a tag? Click a tag in the editor or Tags View to search for notes that contain it. -------------------------------------------------------------------------------- title: "Templates" description: "Create reusable content structures for consistent note-taking" source: "https://docs.octarine.app/organization/templates" -------------------------------------------------------------------------------- # Templates Templates in Octarine allow you to create reusable blocks of content that can be quickly inserted into any note. Unlike page-level templates in other apps, Octarine treats templates as insertable blocks, giving you the flexibility to use multiple templates within a single note. ### The Basics Templates are stored in a dedicated `.templates` folder in your workspace. Each template is a standard markdown file containing the content structure you want to reuse. When applied, the template's content is inserted at your cursor position, not as a new note. - **Block-based approach**: Templates represent content blocks, not entire pages - **Multiple templates per note**: Use several templates to build different sections of the same note - **Standard markdown files**: Templates are regular `.md` files you can edit with any text editor - **Instant insertion**: Template content appears immediately at your cursor location ### Creating Templates Navigate to template creation through these methods: - **Click** the Templates icon in the sidebar to open the Templates view - Press `New template` When creating a template: - Give it a descriptive name that explains its purpose - Include any markdown formatting, headers, lists, or task structures - Add placeholder text where variable content will go ### Template Variables Templates support inline variables that get replaced when the template is inserted or used to create a new note. Variables use double curly braces and can include an optional format for dates and times. Available variables: - `{{title}}`: Current note title (filename without `.md`) - `{{date}}`: Current date in `yyyy-MM-dd` - `{{date:FORMAT}}`: Current date with a custom date-fns format - `{{time}}`: Current time in `HH:mm` - `{{time:FORMAT}}`: Current time with a custom date-fns format > Format for date and time need to be in accordance with date-fns syntax. Please read about them in their [documentation](https://date-fns.org/v4.1.0/docs/format) Example: ```markdown # {{title}} Created: {{date:MMMM d, yyyy}} at {{time}} ``` Variables work in template body content, and they also resolve in template frontmatter when you create a new note from a template. ### Using Templates ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/insert_template.png) Apply templates to your notes using these methods: - On an empty line, press `/` and search for your template name The template content inserts at your current cursor position. You can then edit the inserted content as needed, replacing placeholders with actual information. ### Creating notes from templates Create a new note with content from a template pre-populated by using `CMD/Ctrl + K` and choose the `Create note from template` command with your template selected. Any property assigned to the template is also applied to the new note. #### Quick Answers ### Where are Octarine templates stored? Templates are Markdown files stored in the `.templates` folder inside your workspace. ### Do templates create whole notes or insert blocks? Templates can be inserted as reusable content blocks, and they can also pre-populate new notes through the **Create note from template** command. ### Can Octarine templates use variables? Yes. Templates support variables like `{{title}}`, `{{date}}`, `{{time}}`, and formatted date or time values. -------------------------------------------------------------------------------- title: "Views" description: "Database-style views for organizing and filtering your notes" source: "https://docs.octarine.app/organization/views" -------------------------------------------------------------------------------- # Views Views are dynamic, database-style tables that display your notes based on filters, sorting rules, and custom columns. Think of them as smart saved searches that update automatically. > Views are only available to users on the Pro License. ## Getting Started Unlike the file tree which shows a static folder structure, views let you slice and organize notes by any criteria—dates, properties, tags, tasks, links, and more. **Common use cases:** - Track project notes by status, priority, and deadlines - Monitor all notes with pending tasks across your workspace - Find recently modified notes from the past week - Organize research notes by tags and linked sources - Create custom dashboards for different workflows ### Default Views Octarine creates three views automatically when you set up a workspace: - **Organised Notes** — All notes in your workspace's Notes folder, sorted by last modified date - **Pending Tasks** — Notes containing task checkboxes, showing task status and counts - **Recently Written** — Notes modified in the past 7 days with their linked notes > Views exclusively process frontmatter and metadata properties. Only tags defined in the properties panel are considered. Tags within the note's body or other content-based searches are currently not supported. ### Creating a View 1. Open Views from the sidebar or use `Cmd/Ctrl + K → Go to Views` 2. Click **+ Create View** in the Views panel 3. Name your view and optionally set an icon and color 4. Add filters to define which notes appear 5. Configure columns to display the data you need **Keyboard shortcut:** `g` `w` — Go to Views from anywhere ## Filters Filters define which notes appear in your view. Combine system fields and custom properties to create precise queries. ### Adding a Filter 1. Click the **Add filter** icon in the filter panel 2. Select a field (system or custom property) 3. Choose an operator (equals, contains, before, etc.) 4. Enter or select a value Multiple filters use AND logic—all conditions must match for a note to appear. ### Saving Filters Filter changes are **not saved automatically**. When you add, edit, or remove filters, a live preview updates the table immediately so you can see results before committing. When filters have unsaved changes: - A **Save** button appears in the top-right of the view header — click it to persist your filter changes - An **Undo** button (↩) appears next to it — click it to discard changes and revert to the last saved state All other view settings (columns, grouping, sorting, icon, color) save immediately when changed. Only filters require explicit saving. ### System Fields Built-in metadata tracked by Octarine: | Field | Description | Type | | --- | --- | --- | | Name | Note filename | string | | Path | Full file path | string | | Folder | Folder path excluding the workspace path | string | | Location | Daily, Weekly, Templates, or Notes folder | list | | Created Date | When the note was created | date | | Modified Date | When the note was last edited | date | | Tags | Tags from properties frontmatter | tags | | Linked Notes | Files referenced in note | list | | Linked Media | Attachments referenced in note | list | | Linked Files | External files referenced in note | list | | Task Status | Pending, Complete, or No Tasks | list | | Is Pinned | Note is pinned in file tree | boolean | | Is Locked | Note is read-only | boolean | Custom properties you've defined in your workspace are also available as filter fields. See [Properties](https://docs.octarine.app/note-management/properties) for more. ### Filter Operators Available operators depend on the field type: | Type | Operators | | --- | --- | | **String** | equals, does not equal, contains, does not contain, starts with, ends with, is empty, is not empty | | **Number** | equals, does not equal, greater than, less than, greater than or equal, less than or equal, is empty, is not empty | | **Date/Time** | is, is before, is after, is empty, is not empty | | **Boolean** | is, is not | | **List/Tags** | is any of, is not any of, is empty, is not empty | | **Files** | is empty, is not empty | ### Date Shortcuts When filtering by dates, use relative options like `Today`, `Yesterday`, `Last 7 Days`, `Last Week`, `Last Month`, `This Quarter`, or pick a specific date from the calendar. ## Columns Columns control which data fields appear in your view table. ### Managing Columns 1. Click the columns icon in the view header 2. Toggle checkboxes to show or hide columns 3. Drag to reorder columns The Name column is always pinned to the left and stays visible when scrolling horizontally. ### Column Types Each column renders data based on its type: | Type | Display | | --- | --- | | **String** | Plain text (supports doclinks) | | **Number** | Right-aligned numeric values | | **Date/DateTime** | Formatted dates and times | | **Checkbox** | Visual checkmark or empty state | | **List** | Comma-separated values | | **Tags** | Color-coded tag pills | | **Tasks** | Task count and status indicator | | **Links** | Clickable note/file references | Column types are detected automatically from property definitions or system fields. ### Resizing Columns Drag the edge of any column header to resize it. Column widths are saved per view and restored when you reopen it. ### Reordering Columns Drag and drop column headers to rearrange them. The Name column is always pinned to the left and cannot be moved. ## Sorting Click a column header to sort by that field. Click again to toggle between ascending and descending order. Sort indicators (↑↓) show the current direction. Sorting is saved with the view and applied automatically when reopened. ## Grouping Grouping organizes your view rows under collapsible section headers based on a field's values. ### Selecting a Group Field 1. Click the **Group** icon in the view header toolbar 2. Select a field from the popover — system fields appear under "Octarine" and custom properties under "Properties" 3. To remove grouping, select **No grouping** at the top of the list Not all fields support grouping. The following are excluded: Name, Path, Tasks, Linked Notes, Linked Media, Linked Files, and Related Notes. ### How Groups Work - Each unique value of the selected field becomes a group header - **Array fields** (like Tags or list properties) place a note into multiple groups — one for each value - Notes without a value for the grouped field appear under a **"No value"** group - Click a group header to **collapse or expand** its rows - A **sticky group header** remains visible at the top of the table as you scroll through a long group ### Automatic Bucketing Numeric and date fields are automatically bucketed into readable ranges instead of showing raw values: | Field | Buckets | | --- | --- | | **Word Count** | < 100, 101–200, 201–500, 501–1,000, 1,001–2,000, 2,001+ | | **Line Count** | < 10, 11–25, 26–50, 51–100, 101–250, 251+ | | **Character Count** | < 500, 501–1,000, 1,001–2,500, 2,501–5,000, 5,001–10,000, 10,001+ | | **Reading Time** | < 1 min, 1–5 mins, 6–10 mins, > 10 mins | | **Created / Modified Date** | Today, Yesterday, Past 7 days, Past 30 days, Past 3 months, Past year, Over a year ago | ### Group Sorting When grouping is active, a sort direction toggle appears next to the group field chip: - Click to toggle between **ascending** (↑) and **descending** (↓) group order - For bucketed fields, groups follow their canonical order (or reversed) - For text fields, groups are sorted alphabetically - The **"No value"** group always sorts last, regardless of direction Group sort direction is saved with the view. ## Note Preview Sheet Clicking a note's name in the view table opens a **preview sheet** — a sliding panel on the right side of the screen that lets you inspect a note without leaving the view. ### What the Sheet Shows - **Read-only preview** of the full note content - **Note statistics** — created date, modified date, word count, character count, line count, reading time - **Properties panel** — collapsed view of the note's frontmatter properties - **"Edit in Tab"** button to open the note for editing ### Navigating Between Notes Use the arrow buttons at the top of the sheet, or keyboard shortcuts: | Key | Action | | --- | --- | | `j` or `↓` | Next note | | `k` or `↑` | Previous note | Navigation follows the current table order, respecting any active filters, sorting, and grouping. ## Customizing Views ### Name Click the view name at the top to edit it. Press `Enter` to save or `Escape` to cancel. View names must be unique within the workspace — duplicate or empty names show an inline error. ### Icon and Color Click the icon next to the view name to open the picker: - 50+ built-in icons organized by category - Multiple preset colors that adapt to your theme Icons and colors help identify views at a glance in tabs and the sidebar. ## Managing Views ### Opening Notes Click any note name in the table to open the preview sheet. Use the **"Edit in Tab"** button in the sheet to open the note in a full editor tab. ### Duplicating Right-click a view in the Views tree and select **Duplicate View**. Modify the copy without affecting the original. ### Deleting Either right-click a view and select **Delete**, or open the view and click the delete icon. All tabs displaying that view close automatically. ## Tips - **Quick navigation** — Use `Cmd/Ctrl + K` and type a view name to jump directly to it - **Stack filters** — Create complex queries like "tags contains project-alpha AND modified this week" - **Save when ready** — Tweak filters freely, preview results live, then save once you're happy - **Property-first workflow** — Add properties to notes, then create views to organize them - **Preview without leaving** — Click a note name to peek at its content in the sheet panel, navigate with `j`/`k` ## Troubleshooting | Issue | Solution | | --- | --- | | View is empty | Remove filters one by one to identify which excludes your notes | | Filters not persisting | Click the **Save** button after editing filters — changes require explicit saving | | Slow performance | Prefer metadata filters (properties, tags, system fields) over content searches | | Missing columns | Click the columns icon — some may be hidden | | Properties not showing | Ensure the property exists in `properties.json` and is set on at least one note | | Grouping field missing | Some fields (Name, Path, Tasks, Links) cannot be used for grouping | #### Quick Answers ### What are Views in Octarine? Views are database-style tables that show notes based on filters, sorting, grouping, and custom columns. ### Do Views require Octarine Pro? Yes. Views are available to Pro license users. ### Can Views filter by custom properties? Yes. Views can filter and group notes using system fields and custom workspace properties. -------------------------------------------------------------------------------- title: "Themes" description: "Make Octarine look the way you want" source: "https://docs.octarine.app/customisation/themes" -------------------------------------------------------------------------------- # Themes Octarine comes with a collection of carefully crafted themes to suit different preferences and working environments. Whether you prefer a dark interface for late-night writing or a bright, airy look for daytime work, there's something here for you. ## Switching Themes You can change your theme from **Settings → Preferences → Theme**, or use the command palette (`Cmd/Ctrl + K`) and search for the theme name directly. Octarine lets you set different themes for light and dark mode. So if your system switches between modes throughout the day, Octarine will follow along with the appropriate theme for each. ## Free Themes These four themes are available to everyone: - **Dark** — A balanced dark theme that's easy on the eyes. Great for most situations. - **Light** — Clean and bright, perfect for well-lit environments. - **Dim** — A softer dark option with reduced contrast. Nice for evening work. - **Bright** — A crisp, high-contrast light theme. ## Pro Themes With a Pro license, you unlock access to 30+ additional themes. Here's what's available: ### Dark Themes - **True Dark** — Pure black backgrounds for OLED displays - **Catppuccin Mocha** — Warm, cozy dark theme from the popular Catppuccin palette - **Catppuccin Macchiato** — Slightly lighter variant of Catppuccin - **Catppuccin Frappé** — Medium-dark Catppuccin option - **Dracula** — The beloved dark theme with purple accents - **Rosepine** — Elegant dark theme with soft, muted colors - **Rosepine Moon** — Darker variant of Rosepine - **Gruvbox Dark** — Retro-inspired warm dark theme - **Ayu Dark** — Modern, refined dark palette - **Vesper** — Subdued dark theme with amber highlights - **Vesper Dusk** — Warmer variant of Vesper - **Monokai Pro** — Classic developer favorite - **Monokai Pro Spectrum** — Monokai with cyan accents - **Monokai Pro Machine** — Monokai with teal tones - **Forest Dark** — Nature-inspired greens on dark - **Xcode Dark** — Apple's dark coding theme - **Xcode Midnight** — Even darker Xcode variant - **Xcode Sunset** — Warm Xcode dark theme - **Xcode Dusk** — Purple-tinted Xcode dark - **Cyberpunk** — Neon-soaked futuristic vibes - **Synthwave** — Retro 80s aesthetic with hot pink and cyan ### Light Themes - **Catppuccin Latte** — Soft, creamy light theme from Catppuccin - **Rosepine Dawn** — Light variant of the Rosepine palette - **Gruvbox Light** — Warm, paper-like light theme - **Ayu** — Clean, modern light palette - **Vesper Light** — Warm light theme with amber accents - **Olive** — Earthy greens on a light background - **Rose** — Soft pink-tinted light theme - **Solarized** — The iconic light theme designed for readability - **Synthwave Light** — Pastel take on the synthwave aesthetic - **Forest Light** — Nature-inspired light theme - **Xcode Light** — Apple's classic light coding theme #### Quick Answers ### How do I change themes in Octarine? Change themes from **Settings -> Preferences -> Theme**, or use the Command Palette and search for the theme name. ### Can Octarine use different light and dark themes? Yes. You can choose separate themes for light and dark mode. ### Which Octarine themes are free? The free themes are Dark, Light, Dim, and Bright. Pro unlocks additional theme options. -------------------------------------------------------------------------------- title: "Theme Creator" description: "Design your own custom color themes for Octarine." source: "https://docs.octarine.app/customisation/theme-creator" -------------------------------------------------------------------------------- # Theme Creator Imagine a workspace that perfectly mirrors your style. With the Theme Creator, you can design stunning custom themes from the ground up or effortlessly fine-tune an existing one to make it uniquely yours. ## Getting Started Ready to personalize your workspace? Just navigate to `Settings → Theme Creator` to launch the theme builder. Here, you'll find any custom themes you've already crafted, alongside a clear button to start a fresh creation. > Access to the Theme Creator requires a Pro License. ## Crafting Your Custom Theme To begin bringing your vision to life, simply click **Create New**. You'll first define some fundamental aspects: ### The Essentials - **Theme Name:** Choose a name that helps you easily identify your unique creation. - **Base Theme:** Select one of Octarine's pre-built themes as your foundation. This smartly populates all color variables, giving you a strong starting point rather than an empty canvas. - **Mode:** Decide between **Light** or **Dark** using the radio buttons. This choice is vital, as it governs the appearance of callouts, folder icons, notifications (toasts), and various other UI elements. Selecting an incorrect mode can unfortunately make parts of your interface difficult to read. > Your chosen base theme is permanent after creation. Since it cannot be changed later, pick the option that most closely aligns with the look you're aiming to tweak. ### Fine-Tuning Your Colors Once your base is set, you'll discover all theme variables neatly organized by category. Each variable comes with a handy color swatch and a text field, ready for you to input any standard CSS color value (like hex codes, RGB, or HSL). ### Where Colors Show Up Use this table to map variables to feature surfaces in the app. Each row is a high-level summary of where a color typically appears. | Variable | Where they would be used | | --- | --- | | `--color-text-primary` | Active/Hovered text or icon color. Primary buttons | | `--color-text-secondary` | File tree buttons, Tab buttons | | `--color-text-tertiary` | Captions, Disabled text, Secondary labels, Status hints | | `--color-text-placeholder` | Input placeholders, Empty states | | `--color-text-link` | Links | | `--color-text-accent` | Active states, AI actions, Highlights, Badges | | `--color-editor-body` | Editor paragraphs | | `--color-editor-heading` | Editor headings, H1-H6 | | `--color-text-error` | Error text, Destructive Actions | | `--color-bg-primary` | App canvas, Main panels, Dialog bodies, Editor surface | | `--color-bg-intermediate` | Toolbars, Sticky headers, Floating panels, Side panels | | `--color-bg-secondary` | Cards, Menus, Popovers, Dropdowns | | `--color-bg-tertiary` | Sub-panels, Secondary controls, Scroll containers, Toggles | | `--color-bg-hover` | Hover color. Usually paired with `bg-secondary` | | `--color-bg-accent` | Theme’s primary color | | `--color-bg-doc-link` | Wikilinks, Text selection, background for icons with `text-accent` | | `--color-bg-mark` | Highlight background for searched text | | `--color-bg-error` | Destructive buttons, Danger zones, Error panels, Delete actions | | `--color-bg-kbd` | Keyboard shortcuts | | `--color-bg-tooltip` | Tooltip background | | `--color-app-sidebar` | Sidebar background, Nav rail, Panel chrome, Left rail | | `--color-border-primary` | Primary border - usually light | | `--color-border-secondary` | For active/hover borders - usually darker/brighter | | `--color-border-accent` | Focus states, Active selection borders, Emphasis outlines, Tabs | | `--color-border-error` | Invalid inputs, Error alerts, Destructive outlines, Warnings | | `--color-icon` | Icon base color. On hover/active usually is `text-primary` | | `--color-outline-primary` | Focus rings, Keyboard focus, A11y outlines, Active input | #### Graph View Colors Graph View pulls a smaller set of variables for the canvas and node styling. | Variable | Usage in Graph View | | -------------------------- | ------------------------------------------ | | `--color-text-primary` | Graph title text | | `--color-text-secondary` | Node label text, Node count text | | `--color-text-tertiary` | Default node fill, Search placeholder text | | `--color-text-accent` | Weekly/Daily node fill | | `--color-bg-primary` | Graph canvas background | | `--color-bg-mark` | Tag node fill | | `--color-bg-accent` | Highlighted node/link stroke | | `--color-border-secondary` | Link stroke color | | `--color-border-primary` | Graph header divider | | `--color-app-sidebar` | Graph header bar background | | `--color-icon` | Search and close icons | ## Let AI Inspire You Feeling a bit stuck, or just want to experiment? The **Ask AI** feature is your creative partner! Simply describe the aesthetic you're dreaming of—perhaps a 'cozy autumn forest' or a 'neon cyberpunk night'—and Octarine will intelligently generate a complete color palette and even suggest a fitting theme name. ### Generating a Palette Just tell the AI your desired vibe, and it will handle the initial creative heavy lifting, filling in all the variables and suggesting a name. ### Refining AI Suggestions - **Pro Tip:** Don't hesitate to ask for minor adjustments like 'lighter borders' or 'warmer accents' to perfect your current theme. If you're looking for a completely new direction, describe an entirely fresh identity to get a brand-new palette. - **Model Information:** The 'Ask AI' functionality utilizes the same AI model you've configured in the **Ask Octarine / Writing Assistant** settings. ## Managing Your Themes Once you've created your themes, managing them is straightforward. ### Editing Existing Themes To fine-tune a theme, simply click on it from your custom theme list to open the editor. Make your desired adjustments, then click **Update** to save your changes. What's neat is that your edits are instantly reflected across the entire app, allowing you to see a live preview before finalizing. ### Sharing and Importing Themes Looking to share your masterpiece or back it up? The **Copy CSS** button lets you grab a block of CSS variables. To import a theme, use **Paste from Clipboard**. Keep these important details in mind when pasting: - The CSS you paste must exclusively contain variable lines; **comments are not supported**. - Should your pasted list be incomplete, Octarine will intelligently fill in any missing variables using the colors from your **current base theme**. ### Removing Themes If you need to declutter, simply click **Delete** from the theme list to remove a theme. Be aware that this action is **not reversible**. If the theme you're deleting is currently active, Octarine will automatically revert to the default theme (`default-dark`). ## Applying and Storing Your Creations Once your perfect theme is ready, putting it to use is simple. ### Making Your Theme Active After you create or update a theme, it automatically becomes your active theme. You can effortlessly switch between any of your custom themes at any time: - Via `Settings → Preferences → Theme` - Through the Command palette (`Cmd/Ctrl + K`, then search for your theme name) Your custom themes will appear right alongside Octarine's built-in themes in the selector, complete with helpful color previews. ### Theme File Location For those curious about where your custom themes reside, they are stored on a per-workspace basis in: - `.octarine/themes.json` ## Pro Tips for Stellar Themes Crafting a truly great theme involves a bit of careful consideration. Here are some pro tips to ensure your themes look fantastic and function perfectly: - **Prioritize Contrast:** Ensure your text is always easily readable against its background. Good contrast is key for accessibility and comfort. - **Thorough Testing is Essential:** Don't just admire it; put your theme through its paces. Check how it looks in the sidebar, editor, within callouts, and especially with code blocks. - **Choose Accent Colors Wisely:** These colors highlight important elements like links, buttons, and selected text. Aim for a hue that stands out beautifully without being overly jarring. - **The Right Mode Makes All the Difference:** Remember, your chosen Light/Dark mode influences icons, callouts, and notifications. Selecting the correct mode is crucial to maintain overall readability and prevent UI issues. #### Quick Answers ### Can I create custom themes in Octarine? Yes. Theme Creator lets you build custom themes from a base theme and edit the app's color variables. ### Does Theme Creator require Pro? Yes. Theme Creator requires a Pro license. ### Where are custom themes stored? Custom themes are stored per workspace in `.octarine/themes.json`. -------------------------------------------------------------------------------- title: "Folder Sorting and Icons" description: "Add distinct icons, colors and custom sorting to folders" source: "https://docs.octarine.app/customisation/folder-sorting-and-icons" -------------------------------------------------------------------------------- # Folder Sorting and Icons Folders in Octarine go beyond simple directories—they help you organize notes with visual clarity and custom behavior. With folder customization, you can give each folder its own look and feel. ## What you can customize - **Icons and colors** — Assign unique icons and colors to folders for quick visual identification. - **Custom sorting** — Set a sorting method for each folder independently. For example, sort one folder alphabetically and another by most recently edited. ## How it works Customizations are stored in a `config.json` file inside each folder, so your settings stay with your workspace wherever it goes. > Folder customization requires a Pro License. #### Quick Answers ### Can I customize folder icons in Octarine? Yes. Folder customization lets you assign distinct icons and colors to folders. ### Can each folder have its own sorting method? Yes. You can set custom sorting per folder, such as alphabetical sorting for one folder and recently edited sorting for another. ### Does folder customization require Pro? Yes. Folder sorting and icons require a Pro license. -------------------------------------------------------------------------------- title: "Daily Desk" description: "A focused calendar-based journaling and note-taking tool for daily and weekly entries." source: "https://docs.octarine.app/daily-desk/index" -------------------------------------------------------------------------------- # Daily Desk ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/daily_desk.png) The Daily Desk is Octarine's dedicated journaling and daily note-taking system, providing a streamlined calendar-based interface for creating date-specific notes. Unlike general note organization, the Daily Desk focuses solely on daily/weekly entries, offering a clean separation between your regular notes and time-based content. ### The Basics The Daily Desk uses a dedicated calendar interface in the left sidebar that handles only daily notes, keeping them distinct from your general note collection. Each day automatically generates a markdown file named with the date, creating a chronological record of your thoughts, tasks, and activities. - Daily notes are stored in the `Daily` folder of your workspace. - Each note follows a `YYYY-MM-DD.md` format. Eg — `2025-02-09.md` - Weekly notes are stored in the `Daily/Weekly` folder of your workspace. - Each weekly note follows the `YYYY-W.md` format — Eg: `2025-W3.md` If a daily note has been created, it’ll be indicated with a small `dot` below the number. **Hover** over any such date to quickly preview the note’s content. ### Calendar Navigation Navigate through your daily notes using multiple methods: - **Click** any date in the calendar to open or create that day's note - **Keyboard shortcuts**: Use the shortcuts listed below the calendar for rapid navigation - **Smart Dates**: Press `Cmd/Ctrl + K` and use "Go to Date" with natural language like "yesterday", "next Friday", or "March 15th" - **Arrow keys**: Navigate through dates when the calendar is focused. #### Task Tally Counter The Daily Desk includes a task tally counter that displays the total number of tasks in your daily notes, providing at-a-glance visibility into your daily workload and completion progress. #### Quick Answers ### What is Daily Desk in Octarine? Daily Desk is Octarine's calendar-based system for daily and weekly notes. ### Where are daily notes stored? Daily notes are stored in the `Daily` folder using the `YYYY-MM-DD.md` filename format. ### Where are weekly notes stored? Weekly notes are stored in `Daily/Weekly` using filenames such as `2025-W3.md`. -------------------------------------------------------------------------------- title: "Smart Dates" description: "Natural language date navigation for Daily Desk" source: "https://docs.octarine.app/daily-desk/smart-dates" -------------------------------------------------------------------------------- # Smart Dates ### Smart Dates Integration Ever wanted to jump to a specific date without fumbling through a calendar picker? Octarine's Smart Dates feature lets you navigate through your daily desk using natural language—just type the date the way you'd say it. You can access Smart Dates by opening the command palette with `CMD/Ctrl + K` and selecting "Go to Date", or use the quick shortcut `CMD/Ctrl + D` to jump straight there. The beauty of Smart Dates is that it understands dates the way you think about them. Want to check what you wrote yesterday? Just type "yesterday". Planning something for next Friday? Type "next Friday". You can even use contextual phrases like "in two days" or "three weeks ago"—Octarine figures out exactly what you mean. Here are some examples of what works: - **Relative dates** like "today", "yesterday", "tomorrow", or "next week" - **Specific dates** like "March 15th" or "December 1st, 2024" - **Day references** like "last Monday", "next Friday", or "this weekend" - **Contextual phrases** like "in two days" or "three weeks ago" It's designed to feel natural, so you can navigate your daily notes without breaking your flow. #### Quick Answers ### What are Smart Dates in Octarine? Smart Dates let you jump to Daily Desk notes using natural language dates like `yesterday`, `next Friday`, or `in two days`. ### How do I open Smart Dates? Use `Cmd/Ctrl + K` and choose **Go to Date**, or press `Cmd/Ctrl + D`. ### Can Smart Dates understand relative dates? Yes. Smart Dates understands relative phrases like `today`, `tomorrow`, `next week`, and `three weeks ago`. -------------------------------------------------------------------------------- title: "Migrate Incomplete Tasks" description: "One-click move incomplete tasks from a daily note to today" source: "https://docs.octarine.app/daily-desk/automation" -------------------------------------------------------------------------------- # Migrate Incomplete Tasks Ever have tasks left over from yesterday (or last week) that still need doing? Octarine's task migration feature lets you move all those unfinished tasks to today's note with a single click, so nothing falls through the cracks. ### How It Works When you open today's daily note, Octarine scans your notes from the last 7 days looking for incomplete tasks. If it finds any, a "Migrate Incomplete Tasks" button appears in the breadcrumb. Click it, and those tasks move to today's note—simple as that. ### Using Task Migration The feature works automatically in the background. You don't need to set anything up—just open today's daily note and if there are incomplete tasks from the past week, the migration button will be there waiting for you. It even tells you which date the tasks are coming from, so you have context. Here's what happens when you click that button: Octarine moves all incomplete tasks to today's note at your cursor position, so you won't accidentally overwrite anything. It adds a little note above the tasks saying "Migrated from \[date\]" so you know where they came from. The tasks are removed from their original date, and the front-matter metadata gets updated to track the migration. ### Creating Tasks Want to make sure your tasks are tracked for migration? Just create them using either the `[ ]` checkbox syntax or the `/` command menu and select "Task." Any task created this way gets automatically tracked, so it'll show up for migration if you don't complete it. #### Quick Answers ### What does Migrate Incomplete Tasks do? It moves unfinished tasks from recent daily notes into today's daily note so they do not get lost. ### How far back does task migration look? Octarine scans daily notes from the last 7 days for incomplete tasks. ### How do I create tasks that can be migrated? Use Markdown checkbox syntax such as `[ ]` or create a Task from the `/` command menu. -------------------------------------------------------------------------------- title: "Properties" description: "Custom metadata frontmatter for your notes" source: "https://docs.octarine.app/note-management/properties" -------------------------------------------------------------------------------- # Properties Properties let you add structured metadata to your notes—custom fields for organizing, categorizing, and searching your content. Define them once, reuse them across your workspace. > Properties require a Pro License. ## Overview Properties are metadata fields stored at the top of your notes. Track status, priority, due dates, or anything else that helps you stay organized. Since properties are defined at the workspace level, they remain consistent across all your notes. **Common use cases:** - Track project status and priority levels - Monitor word count and publication stages for writing - Tag sources and confidence levels for research - Set reminders and categorize topics for personal notes ## Property Types Octarine supports seven property types: ### String Free-form text for names, descriptions, or categories. Supports `[[wikilink]]` syntax for linking to other notes. ```yaml Author: Jane Smith Summary: Meeting notes about project timeline Related to: [[Project Alpha]] ``` ### Number Numeric values for counts, ratings, scores, or measurements. ```yaml Word Count: 1250 Priority: 5 Rating: 8.5 ``` ### Date Date values without time—ideal for deadlines and milestones. ```yaml Due Date: 2024-03-15 Publication Date: 2024-04-01 ``` ### DateTime Precise timestamps when time matters. ```yaml Last Edited: 2025-09-23T09:42 Meeting Time: 2025-09-23T15:30 ``` ### Checkbox True/false toggles for completion status or flags. ```yaml Published: true Archived: false ``` ### List Predefined dropdown options for consistent categorization. Supports multiple selections and `[[wikilinks]]`. ```yaml Status: - In Progress - Under Review Person: - [[Jane Doe]] - [[Rajat K]] ``` ### Tags A reserved type that syncs with your workspace's tag tree. Applies only to the `tags` property. ```yaml tags: - project-alpha - meeting - urgent ``` ## Adding Properties to Notes The properties panel appears at the top of each note, below the title. Toggle it with the properties icon in the toolbar—it also shows automatically when a note has existing properties. ### Add an Existing Property 1. Click **+ Add property** at the bottom of the panel 2. Select from the dropdown of workspace properties 3. Set your value ### Create a New Property 1. Click **+ Add property** then **Create new property...** 2. Enter a name and choose a type 3. For List types, define your options 4. The property becomes available across your workspace ### Remove a Property Click the **X** next to any property to remove it from the current note. The property definition remains available for other notes. > Properties not used anywhere are automatically cleaned up and won't appear in suggestions. ### Keyboard Shortcuts - `Cmd/Ctrl + ;` — Add property - `Cmd/Ctrl + Shift + ;` — Focus properties panel - `Tab` — Navigate between properties - `Enter` — Save changes - `Escape` — Cancel editing ## Managing Properties Properties are shared across your workspace—changes affect all notes using them. ### Change a Property's Type 1. Click the property name in any note 2. Select **Change property type** 3. Choose the new type ### Rename a Property 1. Click the property name 2. Select **Rename property** 3. Enter the new name ### Reserved Properties Some properties are managed by Octarine: - **tags** — Syncs with your tag tree - **pinned**, **ai_recap**, **migrated**, **locked** — Hidden system properties for internal tracking ## Additional Features - **AI suggestions** — Click the sparkles icon to analyze your note content and get property suggestions. - **Drag to reorder** — Arrange properties by dragging rows. The order is saved per note. - **Copy properties** — Use the more options menu to copy all properties to your clipboard. - **Undo changes** — Click the undo arrow to revert recent modifications. ## Searching by Properties Filter notes using property values in the search interface with the syntax `[property:]` (e.g., `[status:]`). ## Technical Details ### Storage **Property definitions** are stored in `.octarine/properties.json`—a JSON array that syncs with Git-based backup and is included in workspace backups. **Property values** live in YAML frontmatter at the top of each note file. This standard format keeps your notes portable and editable with any text editor or Markdown tool. ```yaml --- Status: - In Progress Priority: 3 Due Date: 2024-03-15 Published: false Author: Jane Smith tags: - project-alpha - meeting --- # Your Note Title Your note content goes here... ``` #### Quick Answers ### What are properties in Octarine? Properties are structured metadata fields stored in YAML frontmatter at the top of notes. ### Do properties require Octarine Pro? Yes. Properties require a Pro license. ### Where are property definitions stored? Workspace property definitions are stored in `.octarine/properties.json`, while each note's property values live in that note's YAML frontmatter. -------------------------------------------------------------------------------- title: "Note types" description: "Reusable schemas for notes that need the same shape every time." source: "https://docs.octarine.app/note-management/note-types" -------------------------------------------------------------------------------- # Note types Note types are reusable templates for note metadata. They build on [Properties](https://docs.octarine.app/note-management/properties), but save you from rebuilding the same frontmatter over and over. > Note types require a Pro license. Think of a note type as a small schema: a name, an icon, a color, and an ordered set of properties. When you apply it to a note, Octarine adds the right fields and shows the right controls in the properties panel. Definitions live in `{workspace}/.octarine/types.json`, so they sync with the rest of your workspace. ## Why Use Them Properties are flexible. Note types make them consistent. Use note types when a group of notes needs the same structure every time: - Tasks should always have status, priority, due date, and completion. - Reading notes should always track source, author, rating, and status. - Projects should always have owner, stage, start date, and target date. - People notes might need role, company, last contact, and relationship. - Recipes might need prep time, cuisine, rating, and dietary tags. The payoff is small at first and very nice later: views become cleaner, search filters become more reliable, and AI suggestions have a clear schema to fill instead of guessing at property names. ## Built-In Types New workspaces start with three types: | Type | Good for | Typical properties | |------|----------|--------------------| | Task | Work items, errands, follow-ups, bugs | Status, Priority, Due Date, Completed, tags | | Reading | Articles, books, papers, videos, saved links | Source, Author, Status, Rating, tags | | Project | Projects with owners, dates, and changing status | Status, Owner, Start Date, Target Date, tags | You can keep these as-is, rename their fields, or replace them with types that match how you actually use Octarine. ## Practical Examples ### Task Use a task type for anything that needs to move from "not done" to "done" with a bit of extra context. ```yaml --- oct.type: task Status: - In Progress Priority: 2 Due Date: 2026-06-18 Completed: false tags: - launch --- ``` Good for: - Follow-ups from meetings. - Bugs or paper cuts you do not want to lose. - Personal admin that needs a due date. - Small project tasks that deserve their own note. ### Reading Use a reading type when you collect source material and want to remember what it was, who made it, and whether it is worth returning to. ```yaml --- oct.type: reading Source: https://example.com/article Author: Jane Smith Status: - To Summarize Rating: 4 tags: - research - product --- ``` Good for: - Articles you plan to cite later. - Books and papers with highlights. - Videos or talks where the notes matter more than the file itself. - Source material for a project brief or essay. ### Project Use a project type when a note acts as the central place for a piece of work. ```yaml --- oct.type: project Status: - Active Owner: [[People/Rajat]] Start Date: 2026-06-01 Target Date: 2026-07-15 tags: - product --- ``` Good for: - Product features. - Client work. - Research efforts. - Home projects that have enough moving parts to deserve a hub. ### People A custom people type can make personal CRM-style notes much easier to scan. ```yaml --- oct.type: person Company: Acme Role: Designer Last Contact: 2026-06-10 Relationship: - Collaborator tags: - people --- ``` Good for: - Remembering where you met someone. - Tracking follow-ups. - Grouping collaborators, customers, sources, or friends. ### Decision A decision type is useful when you want a durable record of why something changed. ```yaml --- oct.type: decision Status: - Accepted Decided On: 2026-06-12 Owner: [[People/Rajat]] Area: - Editor tags: - decision --- ``` Good for: - Product decisions. - Architecture notes. - Team agreements. - "Why did we do this?" notes you will thank yourself for later. ## Creating And Editing Types Open **workspace Settings -> Note types**. Each type can have: - A name. - An icon. - An accent color. - A description. - An ordered list of properties. Properties can use the same types described in [Properties](https://docs.octarine.app/docs/note-management/properties#property-types): string, number, date, datetime, checkbox, list, and tags. When you assign a type, Octarine records it in frontmatter as `oct.type`. For example, a task note uses `oct.type: task` and then includes the typed fields below it. ## Good Type Design Start with the notes you already create often. If you cannot name at least five notes that would use a type, it might be too early to formalize it. Keep fields boring and reusable. `Status`, `Owner`, and `Due Date` will age better than a dozen fields tuned for one unusually specific note. Prefer list properties when consistency matters. A project status dropdown is easier to filter than five slightly different strings like "Active", "active", "In progress", "Doing", and "currently working". Use descriptions for fields that AI should fill carefully. A clear description helps Octarine suggest values that match your intent instead of simply guessing from the field name. -------------------------------------------------------------------------------- title: "Search" description: "Find and replace content within your notes" source: "https://docs.octarine.app/note-management/search" -------------------------------------------------------------------------------- # Search ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/search.png) In-note search lets you find and replace text within the current note. All matches are highlighted as you type, making it easy to scan through results. ### Finding Text Press `Cmd/Ctrl + F` to open search. If text is selected, it automatically fills the search field. - **Enter** — Jump to next match (wraps around after the last) - **Shift + Enter** — Jump to previous match All matches receive a subtle background highlight, while the current match is emphasized with a stronger color. **Search options:** - **Regex** — Enable regular expressions for advanced pattern matching - **Match Case** — Enable case-sensitive matching (compatible with regex) - **Match Whole Word** — Restrict to complete word matches only (compatible with regex) ### Replacing Text Click the chevron icon next to the search field (or press `Ctrl/^ + Option/Alt + F`) to reveal the replace field. - **Enter** — Replace current match and advance to the next - **Cmd/Ctrl + Enter** — Replace all matches at once -------------------------------------------------------------------------------- title: "Pinned Notes & Folders" description: "Quick access to frequently used notes & folders" source: "https://docs.octarine.app/note-management/pinned" -------------------------------------------------------------------------------- # Pinned Notes & Folders Pin frequently accessed notes and folders for quick access without navigating through your file tree. Individual notes can be pinned on any license; pinning folders requires a Pro License. Pinned items appear in a dedicated tree view. Click the pin icon in the tree (available from Notes, Daily Desk, and Templates) to toggle between pinned items and the normal view. ## Pinning Items Pin a note or folder using any of these methods: - **Right-click** on a note or folder and select **Pin Note** or **Pin Folder** - **Command palette** — `Cmd/Ctrl + K` then **Pin Note** - **Breadcrumb menu** — Click the more options dropdown and select the pin option > The pin icon blinks briefly to confirm the item was pinned. ## Unpinning Items Unpin items using the same methods: - **Right-click** on the pinned item and select **Unpin Note** or **Unpin Folder** - **Command palette** — `Cmd/Ctrl + K` then **Unpin Note** - **Breadcrumb menu** — Select the unpin option from the dropdown -------------------------------------------------------------------------------- title: "Meta Sidebar" description: "Get metadata of the note, backlinks and outline" source: "https://docs.octarine.app/note-management/meta-sidebar" -------------------------------------------------------------------------------- # Meta Sidebar The meta sidebar is one of the sidebars that opens on the right side of Octarine. It's tied to the note you're currently working on, and shows you useful details and information about that note. The sidebar remembers which tab you last viewed, so when you reopen it, you'll land on the same tab. This preference persists across app refreshes and restarts. ### Info The first tab is `Info`, which displays read-only metadata about your note: - When the note was **created** - When it was last **modified** - A count of **characters**, **words**, and **lines**, plus an estimate of how long it would take to read You'll also see any **wikilinks** you've added to the note, with quick previews and access, as well as any media & file attachments. ### Referenced In The second tab shows **backlinks**—other notes that link to this note using wikilink syntax. This makes it easy to see where a note is referenced across your workspace, with quick access to jump to those notes. ### Outline This tab gives you a simple table of contents based on the heading hierarchy in your note. Click any heading in the outline, and the editor will scroll directly to it. Perfect for navigating longer notes. -------------------------------------------------------------------------------- title: "Read-only Notes" description: "Disable editing for a specific note" source: "https://docs.octarine.app/note-management/read-only-notes" -------------------------------------------------------------------------------- # Read-only Notes Got a note you don't want to accidentally change—like a finalized document, reference material, or something archived? You can lock it down by making it read-only. Once locked, the content stays visible but untouchable. ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/read-only-notes.png) > This is available only for Pro License users. ### The Basics When you make a note read-only, Octarine prevents all editing. You can still read the content and copy from it, but you won't be able to modify anything—no typing, no deleting, no formatting changes. It's a simple way to protect important documents from accidental edits. Read-only notes show a crossed pen icon in the file tree and editor, so you can spot them at a glance. And if you need to, you can unlock them just as easily as you locked them. ### Locking Notes There are a few ways to lock a note: Right-click it in the file tree and select "Make note read-only." Or open the note, press `Cmd/Ctrl + K`, and search for "Make note read-only." You can also click the three-dot menu in the note editor and pick the same option. Once it's locked, the crossed pen icon appears, the editor becomes read-only, and all editing shortcuts stop working. Copy operations still work fine, though—you can grab text whenever you need it. ### Unlocking Notes To make a read-only note editable again, use the same methods: Right-click it and select "Make note editable," or press `Cmd/Ctrl + K` and search for it. You can also use the options menu in the note's breadcrumb. The note unlocks instantly and you're back to editing as normal. -------------------------------------------------------------------------------- title: "External Files" description: "Manage file types that aren't natively supported by Octarine" source: "https://docs.octarine.app/note-management/external-files" -------------------------------------------------------------------------------- # External Files Import and reference PDFs, spreadsheets, and other documents alongside your notes. External Files brings non-native file types into your workspace so everything lives in one place. ## How It Works Imported external files are stored in a `.files` folder within your workspace. Reference them in notes using wikilink syntax, just like internal notes. Clicking a reference opens the file in your system's default app—PDFs in your PDF reader, spreadsheets in Excel, and so on. This keeps your workspace organized and ensures all files travel together when syncing via iCloud, Dropbox, or Git. ## Referencing External Files Link to external files using wikilink syntax: ```markdown [[Filename.pdf]] [[project-budget.xlsx]] [[meeting-recording.mp3]] ``` Type `[[` and start typing the filename to see available files. Select one or press Enter to insert the reference. ## Adding External Files There are three ways to add external files: - **Drag and drop** — Drag a file directly into the editor and it will be imported automatically. - **Slash command** — Type `/` and select **Attach Files** to open a file picker. - **Wikilink** — If the file is already in your `.files` folder, type `[[` to search for it and insert a reference. > To reference existing files without re-importing, use the wikilink method or drag from the Attachments sidebar. ## Viewing Linked Files The Meta Sidebar includes a **Linked Files** section showing all external files referenced in the current note. Click any file to open it in your default app. ## Supported File Types Octarine supports these file types by default: - **Documents** — PDF, DOC, DOCX, ODT, RTF, TXT - **Spreadsheets** — XLS, XLSX, CSV, ODS - **Presentations** — PPT, PPTX, ODP - **Audio** — MP3, WAV, M4A, OGG - **Archives** — ZIP, RAR, 7Z, TAR ## Adding Custom Extensions For specialized file types, go to **Settings > Files > External Files**, add extensions (without the dot), and click **Add**. ## Natively Supported Types These file types are handled natively within notes and cannot be added as external files: - **Markdown** — MD - **Images** — PNG, JPG, JPEG, GIF, WEBP, SVG - **Videos** — MP4, MOV -------------------------------------------------------------------------------- title: "Outline Navigation" description: "Quickly navigate long notes using the table of contents command" source: "https://docs.octarine.app/note-management/outline-navigation" -------------------------------------------------------------------------------- # Outline Navigation When working with longer notes that have multiple sections and headings, quickly jumping to a specific section can save time and keep you focused. The Table of Contents command provides instant access to your note's outline without leaving your keyboard. ## Using the Table of Contents Command Access the outline for the current note in two ways: - **Command Palette**: Press `Cmd/Ctrl + K`, then search for "Table of Contents" - **Direct Shortcut**: Press `Cmd/Ctrl + Shift + O` for instant access Either method opens a searchable list of all headers in your note. Selecting any header scrolls the note to that section and places the cursor there, ready for you to continue editing. ## When to Use This The Table of Contents command is especially useful when: - Working with long documents that span multiple screens - Jumping between different sections while editing - Reviewing the structure of a note without scrolling - Navigating to a specific section without using the mouse > Need a persistent view of your note's structure? The meta sidebar's [Outline tab](https://docs.octarine.app/note-management/meta-sidebar#outline) displays a full table of contents that stays visible while you work. -------------------------------------------------------------------------------- title: "Configuring AI" description: "Set up and manage connections to AI providers, including cloud-based APIs and local models." source: "https://docs.octarine.app/working-with-ai/setting-things-up" -------------------------------------------------------------------------------- # Configuring AI Octarine supports multiple AI providers—choose the models that fit your workflow. Use cloud-based services like OpenAI and Anthropic, or run everything locally with Ollama. > AI features require a Pro License. ## Setting Up Providers ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/providers.png) Go to **Settings > AI > Providers** to configure your AI connections. You'll see a list of supported providers: - **Cloud-based** (OpenAI, Anthropic, etc.) — Enter your API key from the provider's console. - **Local** (Ollama) — No credentials required. Octarine validates API keys automatically and displays a checkmark when connected. Enable multiple providers simultaneously and switch between them at any time. ## Selecting Models After configuring providers, available models appear in a dropdown selector grouped by provider. Each model displays its context window size and key features. **Key behaviors:** - Switch models instantly, even mid-workflow - Your last selected model is remembered across sessions - Access the model selector from the AI panel or editor toolbar when AI features are active ## Local Models Run AI models on your own machine for privacy and offline use. Check out our dedicated guides: - [Working with Ollama](https://docs.octarine.app/working-with-ai/working-with-ollama) — Run models locally using Ollama - [Working with LM Studio](https://docs.octarine.app/working-with-ai/working-with-lmstudio) — Use LM Studio for local AI models ## Managing Multiple Providers With multiple providers configured, all models appear in a unified list. Switch between cloud and local models without reconfiguration. **Security and maintenance:** - API keys are stored securely on your device - Update or remove keys anytime in Settings - Clear error messages appear if a provider goes offline or credentials expire #### Quick Answers ### Does Octarine support local AI models? Yes. Octarine can connect to local providers such as Ollama and LM Studio, as well as cloud-based AI providers. ### Do AI features require Octarine Pro? Yes. AI features require a Pro license. ### Where do I configure AI providers in Octarine? Open **Settings -> AI -> Providers** to add, update, or remove AI provider connections. -------------------------------------------------------------------------------- title: "Working with Codex" description: "Use your local Codex CLI account as an AI provider in Octarine." source: "https://docs.octarine.app/working-with-ai/working-with-codex" -------------------------------------------------------------------------------- # Working with Codex Codex is OpenAI's coding agent, but in Octarine it can also act as an AI provider for the Writing Assistant and Ask Octarine. If you already use Codex on your machine, this lets Octarine use that local Codex account instead of asking you to paste another API key. > Codex support requires a Pro License in Octarine and a Codex-capable OpenAI account. ## When To Use Codex Use Codex when you want OpenAI models available through your local Codex setup, especially for heavier reasoning, agent-style Ask Octarine sessions, or prompts where web search and tool use matter. It is a good fit for: - Asking broad questions in Ask Octarine that need the full agent path. - Summarizing or rewriting larger notes with stronger reasoning. - Using web search from the Writing Assistant or Ask Octarine. - Keeping auth tied to your local Codex CLI instead of managing another provider key in Octarine. If you only want a normal OpenAI API key setup, use the OpenAI provider in [Configuring AI](https://docs.octarine.app/docs/working-with-ai/setting-things-up) instead. ## Step 1: Install Codex CLI Install the Codex CLI using OpenAI's official setup instructions: [Codex CLI setup](https://developers.openai.com/codex/cli) After installation, make sure the `codex` command is available from your terminal. ```bash codex ``` The first run will ask you to sign in if you are not already authenticated. ## Step 2: Sign In If Octarine says Codex needs auth, run: ```bash codex login ``` Then come back to Octarine and refresh the Codex status. ## Step 3: Connect Codex In Octarine Open **Settings -> AI -> Providers** and choose **Codex**. Octarine checks your local Codex app-server connection. You do not need to paste an API key; tokens stay with the Codex CLI. Click **Refresh Codex status**. When the connection is working, Octarine shows the account email, plan information when available, and current usage. ## Step 4: Pick A Codex Model Once Codex is connected, Octarine lists the models available through your Codex account. Pick one from the model selector in the Writing Assistant or Ask Octarine. If a default Codex model is available, Octarine selects it automatically when you refresh a working Codex connection. ## Using Codex With Ask Octarine Codex is treated as tool-capable in Ask Octarine, so it can use the full agent flow: search notes, read relevant files, follow links, and answer from the workspace context it gathered. This is useful for messy questions such as: - "What did I decide about the launch plan across my project and daily notes?" - "Find the thread where I changed my mind about pricing." - "Create a short brief from @Projects/Mobile and last week's Daily Desk." Codex can also use web search when the toggle is enabled, so it works well when your notes need current outside context. ## Using Codex With Writing Assistant In the Writing Assistant, Codex works like any other selected model. It can rewrite selected text, draft from the current note, use `@` mentioned notes and folders, and include web search when enabled. For quick typo fixes or short rewrites, a lighter provider may be faster. For larger synthesis, research, or prompts with a lot of context, Codex is often worth choosing. ## Troubleshooting If Codex does not connect: - Make sure the `codex` command works in your terminal. - Run `codex login`, then refresh Codex status in Octarine. - Update Codex CLI if your local version is old. - Restart Octarine after installing Codex CLI, especially if Octarine was already open. - If your workspace is managed by an organization, check whether Codex access needs admin setup. Codex access and available models depend on your OpenAI account and plan. For current setup details, use OpenAI's [Codex docs](https://developers.openai.com/codex). #### Quick Answers ### Can Octarine use Codex as an AI provider? Yes. Octarine can use your local Codex CLI account as a provider for Writing Assistant and Ask Octarine. ### Do I need to paste an OpenAI API key for Codex? No. Codex uses your local Codex CLI authentication, so you do not paste a separate API key into Octarine. ### What should I try if Codex does not connect? Make sure the `codex` command works in your terminal, run `codex login`, refresh Codex status in Octarine, and restart Octarine if you installed Codex while it was open. -------------------------------------------------------------------------------- title: "Working with Ollama" description: "Learn how to connect your Ollama to Octarine to use Writing Assistant and Ask Octarine" source: "https://docs.octarine.app/working-with-ai/working-with-ollama" -------------------------------------------------------------------------------- # Working with Ollama Ollama is a simple way to run large language models on your own machine. This guide shows you how to install it, download a model, and connect it to Octarine so you can use AI features completely offline and privately. ## Prerequisites Ollama works on macOS, Windows, and Linux. Just make sure your system has enough CPU, RAM, and storage to handle the models you want to run. ## Step 1: Install Ollama Visit the [Ollama official website](https://ollama.com/) and download the installer for your operating system. On macOS, open the `.dmg` file and follow the instructions. On Windows, run the `.exe` and complete the wizard. If you're on Linux, check the Ollama website for instructions specific to your distribution. ## Step 2: Pull a Model After installing Ollama, you need to download a model. Open Terminal (on macOS/Linux) or Command Prompt or PowerShell (on Windows), and run this command: ```bash ollama pull llama2 ``` Replace `llama2` with whatever model you want to use. You can find a full list of available models in the [Ollama documentation](https://ollama.com/library). ## Step 3: Start the Ollama Service In the same terminal or command prompt, start the Ollama server: ```bash ollama serve ``` This runs the server on `http://localhost:11434` by default. Keep this terminal window open—you need the service running for Octarine to connect. ## Step 4: Connect Ollama to Octarine Now let's hook it up to Octarine. ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/working_with_ollama.png) Go to `Settings → AI Assistant → AI Providers` and click on **Ollama**. Enter the server URL from the previous step (usually `http://localhost:11434`) and press **Save**. ## Step 5: Start Using Your Models ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/working_with_ollama_models.png) Open the Writing Assistant or Ask Octarine, click the model selector, and look for your Ollama models. Select one and you're ready to go! ## A Few Things to Know The Ollama API only listens on `localhost` by default, so it's not exposed to the internet—everything stays on your machine. If you want to see all the models you've downloaded, run `ollama list` in your terminal. This shows every model currently available. When you're done, you can stop the Ollama service by going back to the terminal where `ollama serve` is running and pressing `Ctrl+C`. #### Quick Answers ### Can Octarine use Ollama? Yes. Octarine can connect to Ollama as an AI provider for Writing Assistant and Ask Octarine. ### Does Ollama keep AI requests local? By default, Ollama runs on `localhost`, so prompts and model responses stay on your machine unless you configure Ollama differently. ### What Ollama URL should I enter in Octarine? Use `http://localhost:11434` unless you changed Ollama's default server address. -------------------------------------------------------------------------------- title: "Working with LM Studio" description: "Learn how to connect your local LMStudio to Octarine to use Writing Assistant and Ask Octarine" source: "https://docs.octarine.app/working-with-ai/working-with-lmstudio" -------------------------------------------------------------------------------- # Working with LM Studio Want to run AI models on your computer without relying on the cloud? LM Studio lets you do exactly that. This guide walks you through installing it, downloading a model, and connecting it to Octarine so you can use the Writing Assistant and Ask Octarine features completely locally. ## Prerequisites You'll need macOS or Windows (Linux support is experimental). Make sure you have enough CPU, RAM, and storage—especially if you're planning to run larger models. ## Step 1: Install LM Studio Head to the [LM Studio website](https://lmstudio.ai/) and download the installer for your operating system. On macOS, open the `.dmg` file and follow the prompts. On Windows, run the `.exe` and complete the installation wizard. If you're on Linux, check the official website for the latest experimental instructions. ## Step 2: Download a Model Once you've installed LM Studio, launch it from your applications folder or start menu. You'll see a built-in model library. Browse it or use the search bar to find a model—popular options include Llama 2, Mistral, and Phi-3. When you find one you like, click **Download** next to it and wait for it to finish. ## Step 3: Start the Local Server LM Studio can run a local API server that Octarine connects to. Go to the **API** tab (usually on the sidebar) and click **Start Server**. By default, it runs on `http://localhost:1234`. Make a note of the URL—you'll need it in the next step. ## Step 4: Connect LM Studio to Octarine Now you're ready to hook everything up. ![Image](https://pub-d9b2979edab5442388c14f8014e177b7.r2.dev/docs/working_with_lmstudio.png) In Octarine, go to `Settings → AI Assistant → AI Providers` and click on **LM Studio**. Enter the local server URL from the previous step (usually `http://localhost:1234`) and press **Save**. ## Step 5: Start Using Your Local Models Open the Writing Assistant or Ask Octarine and click the model selector. You should see your LM Studio models listed there. Select the one you want and start generating! ## A Few Things to Know The LM Studio API only accepts requests from `localhost` by default, so it's safe for local use. If you want to manage your models—delete them, update them, whatever—just use the LM Studio interface. And when you're done, you can stop the server by going back to the API tab and clicking **Stop Server**, or just close LM Studio altogether. #### Quick Answers ### Can Octarine use LM Studio? Yes. Octarine can connect to LM Studio as an AI provider for Writing Assistant and Ask Octarine. ### What LM Studio URL should I enter in Octarine? Use `http://localhost:1234` unless you changed LM Studio's local server address. ### Does LM Studio keep AI requests local? By default, LM Studio accepts API requests from `localhost`, so the model runs on your computer unless you configure it differently. -------------------------------------------------------------------------------- title: "Skills" description: "Reusable AI instructions for writing, research, and workspace questions." source: "https://docs.octarine.app/working-with-ai/skills" -------------------------------------------------------------------------------- # Skills Skills are reusable instructions you can attach to a Writing Assistant or Ask Octarine request. They are useful when you keep asking AI to work in the same way: follow a house style, summarize research with a fixed structure, critique a draft from a particular angle, or turn rough notes into a specific kind of output. > Skills require a Pro License. Think of a skill as a named instruction card. You write it once, then mention it when a prompt needs that behavior. ## Creating Skills Open **Settings -> AI -> Skills**. Click **New Skill**, give it a name, and write the instructions in Markdown. The editor includes a preview tab, so longer instructions are easier to check before saving. For example, a skill named **Release Notes** might say: ```markdown Write for users, not engineers. Prefer short sections with plain headings. Group small changes under Improvements or Fixes. Avoid internal implementation names unless the user needs them. ``` Another skill named **Research Synthesizer** might say: ```markdown Look for recurring themes, contradictions, and concrete examples. Separate facts from interpretation. End with open questions worth following up on. ``` ## Using Skills Type `@` in the Writing Assistant or Ask Octarine prompt box. Skills appear in their own **Skills** section alongside notes and folders. Select one or more skills, then write your prompt as usual. Octarine sends the selected skill instructions with that request, while note and folder mentions still provide source context. For example: - `@Release Notes summarize @Changelog/v0.45 for users` - `@Research Synthesizer what patterns show up in @Interviews/June?` - `@Editor Critic review this selected section for clarity` Skills are not permanent for the whole chat unless you keep selecting them. They are attached to the prompt where you used them, which makes it easy to switch modes inside the same conversation. ## Skills In Writing Assistant Use skills in the Writing Assistant when you want a consistent style or editing lens for the note in front of you. Good uses: - Rewrite selected text in your preferred voice. - Apply a review checklist to a draft. - Turn rough bullets into a recurring format. - Keep release notes, briefs, or summaries consistent across sessions. Skills pair well with selected text. Select the passage, open the Writing Assistant, mention the skill, and ask for the edit you want. ## Skills In Ask Octarine Use skills in Ask Octarine when the answer should follow a repeatable workflow across your workspace. Good uses: - Synthesize a folder of research notes in the same structure every time. - Compare project notes with a decision-making rubric. - Extract action items using a consistent definition of "action item." - Ask the agent to answer in a format you use for briefs, retros, or weekly summaries. In Ask Octarine, skills can guide the agent's work while `@` mentioned notes, folders, date filters, and Daily Desk ranges control the source material. ## Where Skills Live Skills are stored as Markdown files in `.octarine/skills` inside your workspace. That means they can travel with the workspace and are easy to inspect outside Octarine. When you duplicate or copy a workspace through Octarine, its skills can be copied along with it. ## Writing Good Skills Keep skills specific. A skill called **Better Writing** will be vague; **Concise Product Copy** gives the assistant a clearer job. Write instructions as rules the assistant can actually follow: - Say what to prioritize. - Name the format you want. - Include a few "do" and "avoid" notes. - Keep examples short. Avoid stuffing a skill with source material. Use note and folder mentions for source context, and use skills for behavior. #### Quick Answers ### What are Octarine skills? Skills are reusable AI instructions stored in your workspace that guide Writing Assistant or Ask Octarine responses. ### Where are skills stored? Skills are Markdown files in `.octarine/skills` inside your workspace. ### When should I use a skill instead of a slash command? Use a skill for reusable behavior, style, or review rules. Use a slash command for repeatable prompt text. -------------------------------------------------------------------------------- title: "Writing Assistant" description: "Draft, rewrite, research, and edit with context from the note you are working on." source: "https://docs.octarine.app/working-with-ai/writing-assistant" -------------------------------------------------------------------------------- # Writing Assistant The Writing Assistant is the AI panel that sits beside your editor. It is best for the moment when you are already inside a note and want help with the thing in front of you: tightening a paragraph, turning rough notes into a draft, finding a clearer structure, or continuing an idea without leaving the page. > The Writing Assistant is only available to users on the Pro License. Before using it, make sure at least one AI provider or local model is configured. See [Configuring AI](https://docs.octarine.app/working-with-ai/setting-things-up) for setup. ## Opening The Assistant Press `Cmd/Ctrl + J` to open the Writing Assistant. Octarine uses your current note as the starting context, so you can ask natural things like: - "Summarize this into a short intro." - "Rewrite the selected section in a calmer tone." - "Turn these bullets into a draft." - "What is missing from this argument?" If you select text before opening the assistant, only that selection is sent as the main context. You can also select text and choose **Add to chat** from the Bubble Menu. ## Adding More Context Use `@` in the prompt box to add extra context from your workspace. You can mention: - **Notes** when you want the assistant to follow a specific reference. - **Folders** when a whole project, topic, or archive should shape the response. - **Skills** when you want reusable instructions for style, structure, or review behavior. - **Multiple sources** when you want it to compare, combine, or write in the same style as existing notes. The mentions appear as small chips in the prompt box. They stay attached when you edit a prompt, which is useful when the question was right but the context needed one more note. See [Skills](https://docs.octarine.app/docs/working-with-ai/skills) if you want to create reusable instructions for prompts you repeat often. You can remove the current note from context too. That helps when you want a general answer, a fresh idea, or a rewrite based only on the notes you mentioned. ## Working With Long Conversations Each message remembers the prompt, the model, the time, and the context used for that turn. If you switch notes or change the context while a chat is already underway, Octarine marks that the context changed and keeps the conversation grounded in the current material. You can click a previous prompt to edit it. The prompt opens with its original text and `@` mentions intact, then the assistant generates a new answer from the revised request. ## Research Mode Research Mode is for prompts where a quick rewrite is not enough. Instead of rushing into a final answer, the assistant can ask clarifying questions, gather what it needs, and then offer useful next steps such as drafting, summarizing, expanding, or continuing the research. It is a good fit for: - Planning an essay, article, or release note from loose source material. - Turning several notes into a more coherent outline. - Asking for feedback before committing to a structure. - Exploring a topic when you are not sure what the final shape should be yet. ## Web Search Web search lets the assistant include current web sources in its response. Click the globe icon below the prompt box to turn it on or off. Web search is available for OpenAI, OpenAI-compatible providers that support it, Claude, and Codex-backed models. When it is not available for the selected model, the toggle is disabled. ## Using Responses After a response comes back, you can: - **Copy** it to the clipboard. - **Insert** it at your cursor. - **Replace** the selected text with the response. - **Retry** to get another version. - **Delete** it from the chat. For writing work, **Insert** is usually the gentlest option. It lets you compare the suggestion against your original text before deciding what stays. ## Slash Commands Create shortcuts for prompts you reuse often in `Settings -> AI Assistant -> Slash Commands`. Octarine stores them in `.octarine/ai/slash-commands.json` inside your workspace. Slash commands are good for reusable prompt text. [Skills](https://docs.octarine.app/docs/working-with-ai/skills) are better when you want reusable behavior that can be combined with different prompts and different notes. Good slash commands are specific and repeatable: - `/tighten` for making selected prose shorter without changing meaning. - `/outline` for turning messy notes into headings and bullets. - `/release-note` for converting a technical note into user-facing copy. For most writing tasks, a lightweight model is enough. Save the heavier models for deeper research, larger context, or prompts where the assistant needs to reason across several notes. #### Quick Answers ### What can the Writing Assistant do? It can summarize, rewrite, draft, research, and edit using the current note, selected text, and any extra notes or folders you mention. ### How do I open the Writing Assistant? Press `Cmd/Ctrl + J` while working in a note. ### Can the Writing Assistant use web search? Yes, when the selected model supports web search. Turn it on with the globe icon below the prompt box. -------------------------------------------------------------------------------- title: "Ask Octarine" description: "Chat with your workspace, search across notes, and turn scattered context into useful answers." source: "https://docs.octarine.app/working-with-ai/ask-octarine" -------------------------------------------------------------------------------- # Ask Octarine Ask Octarine is the workspace-level AI chat. Use it when the answer is probably somewhere in your notes, but you do not want to manually search, open five files, and stitch the story together yourself. > Ask Octarine is only available for users on the Pro License. ## What It Does Ask Octarine can answer questions, summarize projects, find old decisions, compare notes, and help you create new writing from what already exists in your workspace. With a tool-capable model, Ask Octarine now works more like a small research agent. It can search your notes, read the most relevant ones, follow backlinks and wikilinks, inspect tags, list folders, and then answer from what it found. This is different from a simple one-shot search: it can take multiple steps when the question needs it. For example: - "What did I decide about pricing in the last two months?" - "Summarize everything related to the mobile redesign." - "Find notes that mention the export bug and tell me the current status." - "Create a brief from @Projects/Website and @Meetings/June." - "What open threads did I leave in Daily Desk last week?" If the selected model does not support tools, Octarine falls back to a simpler single-shot search. You will still get answers from your notes, but the full agent path is better for broad, messy, or multi-hop questions. ## First Setup The first time you use Ask Octarine, Octarine downloads a local embedding model. Embeddings make your notes searchable by meaning, and they run on your device. - **MiniLM L6 v2** is the default model. It is smaller, faster, and about 90MB. - **Nomic Embed v1.5** is the higher-quality option. It is about 140MB and takes a little more time and resources to index. - Your notes are indexed locally. - New, renamed, moved, edited, or deleted notes are re-indexed automatically. - Only your actual chat query and the relevant note content are sent to your selected AI provider. To keep the whole flow local, use a local provider such as Ollama or LM Studio. ## Opening Ask Octarine Open it from the sidebar, press `Cmd/Ctrl + O`, or use `Cmd/Ctrl + K -> Ask Octarine`. If indexing is still running, the prompt box shows progress. You can start asking once the workspace is ready. ## Excluding Notes And Folders Use Ask Octarine exclusions when some workspace content should stay out of AI search. Excluded notes and folders are not indexed by Ask Octarine and will not appear as `@` context suggestions. Open `Settings -> AI -> Ignored`, then add the folders or notes you want Ask Octarine to skip. Removing an item from the ignored list makes it available again. When anything is ignored, the prompt box shows an `N ignored` shortcut. Click it to jump back to the exclusions settings. Exclusions are saved in a `.octarineignore` file at the root of the workspace, with one path per line. You can manage the list from settings, or edit the file directly if you prefer. For example: ```txt # Ask Octarine exclusions Private Research/Unpublished.md .templates ``` Ignoring a folder excludes everything inside it. This applies to workspace search, similar note lookup, backlinks, wikilink expansion, note outlines, and direct note reads inside Ask Octarine. ## Controlling Context Ask Octarine can search the whole workspace, but you can narrow it when you already know where the answer should come from. Type `@` in the prompt box to add: - **Notes** for exact source material. - **Folders** for projects, areas, or archives. - **Skills** for reusable instructions, formats, or review lenses. - **Created or modified date filters** for time-bound questions. - **Daily Desk ranges** for questions about a week, month, trip, sprint, or other stretch of days. You can combine several contexts in one prompt. For instance, ask it to compare one folder with another, or use a Daily Desk range plus a project folder so the answer is both time-aware and topic-aware. Skills behave a little differently from notes and folders: they guide how Ask Octarine should work, while the other mentions tell it what material to use. See [Skills](https://docs.octarine.app/docs/working-with-ai/skills) for setup and examples. Octarine is language agnostic. Ask in the language you prefer, and it will answer in the same language. ## Web Search If the selected model supports it, you can turn on web search from the globe icon in the prompt box. Use web search when your notes are the starting point but not the whole answer: checking current facts, filling in public context around a saved link, or comparing your own notes with something that has changed since you wrote them. When web search is unavailable for the selected model, the toggle is disabled. ## Reading The Answer Agent answers may include the notes it used as clickable wikilinks. The chat also keeps a reference list so you can inspect the source material yourself. Each message keeps its own context, model, and references. That means one chat can include a broad workspace question, a follow-up narrowed to a folder, and then a third question using a different model without losing track of what happened. You can copy responses as Markdown or plain text. You can also save the whole chat to a note from the chat breadcrumb; Octarine writes your prompts as blockquotes and separates each exchange with a divider. ## Editing Prompts Click any previous prompt to edit it. Octarine reopens the text with the same `@` mentions, then regenerates the answer from the updated request. This is especially useful when the first answer was close but you want to add a missing folder, tighten the date range, or ask for a different format. ## Suggested Prompts And History New chats show suggested prompts based on a random selection of folders with notes. Refresh them when you want a different starting point. History is grouped by relative date, such as Today, Yesterday, 2d ago, and 1w ago. Saved chats keep their references, so you can return to an answer and still see what it was based on. ## Picking A Model For the full Ask Octarine agent, choose a model that supports tool calling. Octarine will warn you when the current model can only use the simpler search path. Use lighter models for quick summaries and straightforward lookup. Use stronger models when the question spans many notes, asks for synthesis, or needs careful reasoning across projects. #### Quick Answers ### What is Ask Octarine? Ask Octarine is a workspace chat that searches your notes, gathers relevant context, and answers questions from your own Markdown files. ### Can Ask Octarine exclude private notes? Yes. Add notes or folders to `Settings -> AI -> Ignored` so they are excluded from Ask Octarine indexing and context suggestions. ### Can Ask Octarine use web search? Yes, when the selected model supports it. Use the globe icon in the prompt box to turn web search on or off. -------------------------------------------------------------------------------- title: "Weekly AI Recap" description: "AI-generated summaries of your weekly notes" source: "https://docs.octarine.app/working-with-ai/weekly-ai-recap" -------------------------------------------------------------------------------- # Weekly AI Recap #### Weekly AI Recap > This feature is only available to Pro License users. Octarine can generate an AI-assisted recap based on your daily notes from a weekly period. The AI reviews your entries to identify important themes, completed tasks, and recurring topics, highlighting achievements and patterns that emerged throughout the week. The recap is generated in the same language as your notes and appended to the bottom of your weekly note, preserving any existing content and note properties. This saves you from manually reviewing multiple daily entries and provides a consolidated view of your progress and activities. To generate a weekly recap: - Navigate to any weekly note want to review - Look for the `Generate Recap` button on the top right - Thematic Review — Analyses themes and patterns across your week's notes - Daily Recap — Summarises each day's activities in a chronological way. - Post creation, it'll prompt you to either Accept or Reject these changes. - If you reject, the note is restored to its previous state and you can retry. - If you accept, a key is added to the frontmatter of the note stating that the recap is generated, and the button won't be visible again until the note is deleted. You can choose whether the recap looks at the current week or past week in `Settings → Preferences -> Weekly Recap Period`. #### Quick Answers ### What is Weekly AI Recap? Weekly AI Recap summarizes a week of daily notes into themes, completed tasks, and recurring topics. ### Does Weekly AI Recap require Pro? Yes. Weekly AI Recap is available to Pro license users. ### Can I reject a generated recap? Yes. After generation, you can accept the recap or reject it to restore the weekly note to its previous state. -------------------------------------------------------------------------------- title: "Git Sync" description: "Automated GitHub/GitLab backup for your workspace" source: "https://docs.octarine.app/backup/git-sync" -------------------------------------------------------------------------------- # Git Sync Git Sync provides automated backup functionality for your Octarine workspace, syncing your notes and folders to GitHub or GitLab repositories. This feature operates as a backup service rather than real-time synchronization, ensuring your content is safely stored in version control. ### Prerequisites Git Sync requires Git to be installed on your system: - Verify by running `git -v` in Terminal/Powershell. - **Installation**: If Git is missing, your system will prompt for automatic installation when you run the verification command - **SSH Setup**: Configure SSH keys for GitHub/GitLab authentication - [github setup](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) - **Passphrase Storage**: Save SSH key passphrases to enable automated syncing without password prompts. This is essential for Git Sync to function properly ### Setting Up Git Sync Git Sync can be configured in two ways: ### Manual Setup - **Create Repository**: Start with a new, empty repository on GitHub or GitLab to avoid merge conflicts during beta - **Copy SSH URL**: After creating the repository, copy the SSH URL (format: `git@github.com:username/repository.git`) - **Configure in Octarine**: Navigate to `Settings → Git Sync` and paste the SSH URL - **Complete Setup**: Click "Finish Setup" to initialize the connection #### Automatic Setup - **Git-Enabled Folders**: When creating a workspace from a folder that already contains git configurations (such as folders cloned with `git clone`), Git Sync is automatically configured - **No Additional Setup**: The existing git remote is detected and used without manual configuration Octarine will perform an initial backup of all current files, excluding attachments by default to manage storage usage. ### Configuration Options After setup, the Git Sync preferences screen allows you to customize backup behavior: - **Automated Backups**: Toggle periodic backups on or off - **Sync Interval**: Set the frequency for backup checks (default: 10 minutes) - **Content Exclusions**: Choose whether to exclude: - Attachments (excluded by default due to potential size) - Templates - Files (excluded by default due to potential size) - **Remove Integration**: Disconnect the workspace from Git and remove version control ### Monitoring Sync Status The sync status is visible through visual indicators in the interface: - **Cloud Icon**: Located in the top-right breadcrumb area - Hover to view the last successful sync timestamp - Normal appearance indicates successful synchronization - **Warning Icon**: Replaces the cloud icon when sync errors occur - Hover to see specific error details - Manual intervention may be required to resolve Git-related issues - Will show up when `Auto Sync` is turned off. > Whenever an error does occur, auto sync is turned off. Octarine tries to retry syncing 3 times before it turns auto sync off and shows the warning icon. ### Sync Behavior Git Sync operates with these characteristics: - **Automatic Operation**: Runs in the background at configured intervals - **Initial Pull**: When the app loads or when manually reloaded, a pull is triggered to fetch latest changes from the remote repository - **File Coverage**: Backs up all markdown files and folder structure - **Exclusions**: Attachments, Files or templates can be optionally excluded - **Repository Structure**: Maintains your exact workspace folder hierarchy in the Git repository - **Manual Sync**: You can force sync by either `Cmd/Ctrl + K → Sync Now` or head over to `Settings → GitSync` and press the `Sync Now` button. ### Conflict Resolution Git Sync provides automatic conflict resolution when local and remote changes conflict: - **Conflict Resolution Settings**: Located in `Settings → Git Sync → Conflict Resolution` - **Resolution Options**: - **Use Remote Changes**: The app favors incoming changes from the remote repository. Remote always wins - **Keep Local Changes**: The app favors your current local changes. Local always wins - **Automatic Handling**: Based on your selected preference, conflicts are resolved automatically during sync operations - **No Manual Intervention**: Unlike traditional Git workflows, conflicts are handled according to your predefined preference ### Troubleshooting Common issues and their resolutions: - **SSH Authentication Failures**: Ensure SSH keys are properly configured and passphrases are saved - **Merge Conflicts**: Start with empty repositories during beta to avoid conflicts - **Sync Errors**: Check the warning icon for specific error messages - **Repository Access**: Verify you have write permissions to the target repository For complex Git-related issues, knowledge of Git commands may be helpful for manual resolution through Terminal. #### Quick Answers ### Is Git Sync real-time sync? No. Git Sync is an automated backup feature for GitHub or GitLab repositories, not a real-time multi-device sync system. ### What do I need before setting up Git Sync? You need Git installed, SSH authentication configured for GitHub or GitLab, and an empty or compatible repository to use for backup. ### Can Octarine resolve Git Sync conflicts automatically? Yes. You can choose whether Octarine should prefer remote changes or keep local changes when conflicts happen. -------------------------------------------------------------------------------- title: "Dropbox" description: "Backup your workspace to Dropbox" source: "https://docs.octarine.app/backup/dropbox" -------------------------------------------------------------------------------- # Dropbox Using Dropbox with Octarine is straightforward—since your notes are just markdown files on your computer, they sync through Dropbox like any other file. Once you create your workspace in a Dropbox folder, everything syncs automatically across all your devices. ### Setting Up Dropbox Sync Getting started is simple: 1. **Install Dropbox desktop app** and sign in 2. **Open Octarine** and create a new workspace (or open an existing one) 3. **Navigate to your Dropbox folder** when choosing the location — it's usually in your home directory 4. **Create or select a folder** for your workspace 5. **Start working** — Octarine will now save all your notes to this Dropbox folder, and Dropbox handles the syncing behind the scenes ### How It Works Octarine doesn't need any special setup to work with Dropbox. It just reads and writes files to your local Dropbox folder, and Dropbox does what it does best—keeps everything in sync across your devices. You can access your notes on Windows, macOS, Linux, or even mobile devices through Dropbox's app. If you're tight on storage, you can use Dropbox's Smart Sync feature to keep files online-only. When you open a note in Octarine, Dropbox downloads it automatically. And if you ever need to recover a deleted note or roll back to an earlier version, Dropbox's web interface has you covered. ### Working with Teams Want to collaborate with others? Create your workspace in a shared Dropbox folder. Team members with access will see updates within seconds, and you can control who has read or write access through Dropbox's folder settings. Team members can even add comments via Dropbox's web or mobile apps. ### When Things Don't Sync If your notes aren't syncing properly, here's what to check: - **Check Dropbox is running** and you're signed in - **Look for the green checkmark** on your workspace folder in Finder or Explorer - **Verify storage quota** — low storage can block new syncs - **Pause and resume sync** in Dropbox preferences to kickstart syncing - **Refresh the file tree** by clicking the refresh icon in Octarine's toolbar - **Check selective sync settings** — make sure your workspace folder is selected to sync on this device #### Quick Answers ### Can I use Dropbox to sync Octarine notes? Yes. Create or place your Octarine workspace inside your local Dropbox folder, and Dropbox will sync the Markdown files like any other files. ### Does Octarine need a special Dropbox integration? No. Octarine reads and writes files locally; the Dropbox desktop app handles syncing in the background. ### What should I check if Dropbox sync stops working? Make sure Dropbox is running and signed in, confirm the workspace folder is selected for sync, check storage quota, and refresh the Octarine file tree. -------------------------------------------------------------------------------- title: "OneDrive" description: "Backup your workspace to OneDrive" source: "https://docs.octarine.app/backup/onedrive" -------------------------------------------------------------------------------- # OneDrive If you're a Microsoft 365 user or just prefer OneDrive for cloud storage, you can easily sync your Octarine notes across all your devices. Since Octarine saves everything as plain markdown files, all you need to do is create your workspace inside a OneDrive folder and let Microsoft handle the syncing. ### Setting Up OneDrive Sync Getting started is straightforward: 1. **Install OneDrive desktop app** and sign in with your Microsoft account 2. **Open Octarine** and create a new workspace (or open an existing one) 3. **Navigate to your OneDrive folder** when choosing where to save — you'll usually find it in your home directory or under "This PC" on Windows 4. **Create or select a folder** for your workspace 5. **Start working** — Octarine will save your notes to this OneDrive folder, and OneDrive takes care of syncing them to the cloud and your other devices ### How It Works Octarine doesn't do anything special with OneDrive—it just treats it like any other folder on your computer. When you save a note, it's written to your local OneDrive folder, and OneDrive automatically syncs it to the cloud and your other devices. You can access your notes on Windows, macOS, mobile devices, or even through the OneDrive web interface. If you're low on disk space, OneDrive's Files On-Demand feature lets you keep files in the cloud and download them only when you need them. When you open a note in Octarine, OneDrive downloads it automatically, so you don't even notice the difference. And if you accidentally delete something or want to revert to an earlier version, OneDrive's version history and recycle bin have you covered—just head to the web interface to restore what you need. ### Working with Teams OneDrive makes collaboration simple. Create your workspace in a shared OneDrive folder (or a SharePoint library if you're using Microsoft 365 for work), and anyone with access can see your notes. Updates sync in real-time, and you can control permissions through OneDrive's sharing settings to decide who can view or edit. Team members can also use OneDrive's commenting features on the web or mobile to leave feedback without editing the files directly. ### When Things Don't Sync If your notes aren't syncing, here's what to check: - **Check OneDrive is running** and you're signed in - **Look for the cloud icon** in your system tray (Windows) or menu bar (macOS) — a checkmark or "Up to date" means everything's synced - **Click the icon for errors** if you see a sync error notification - **Verify storage quota** — if you're out of space, new changes won't sync - **Pause and resume sync** in OneDrive settings to kickstart syncing - **Refresh the file tree** by clicking the refresh icon in Octarine's toolbar - **Check Files On-Demand settings** — set your workspace folder to "Always keep on this device" instead of "Free up space" #### Quick Answers ### Can I sync Octarine notes with OneDrive? Yes. Create or move your Octarine workspace into your local OneDrive folder and OneDrive will sync the Markdown files. ### Does OneDrive Files On-Demand work with Octarine? Yes, but for reliability you may want to mark the workspace folder as **Always keep on this device** so notes are available locally. ### Can teams collaborate on an Octarine workspace in OneDrive? Yes. A shared OneDrive folder or SharePoint library can hold an Octarine workspace for people with access. -------------------------------------------------------------------------------- title: "iCloud" description: "Backup your workspace to iCloud" source: "https://docs.octarine.app/backup/iCloud" -------------------------------------------------------------------------------- # iCloud If you're in the Apple ecosystem, iCloud Drive makes it easy to keep your notes synced across all your devices. Since Octarine just saves your notes as regular markdown files, you can drop your workspace right into iCloud Drive and let Apple handle the rest. ### Setting Up iCloud Sync Getting started is quick: 1. **Open Octarine** and create a new workspace (or open an existing one) 2. **Navigate to iCloud Drive** when choosing where to save — you'll usually find it under Locations in the file picker sidebar 3. **Create or select a folder** for your workspace 4. **Start working** — Octarine will now save everything to that iCloud folder, and your notes sync automatically to any device signed in with your Apple ID ### How It Works Octarine doesn't do anything special with iCloud—it just reads and writes files to your iCloud Drive folder like any other app. When you make a change, it's saved to iCloud immediately and appears on your other devices within seconds. You can edit a note on your Mac and pick up where you left off on your iPad or iPhone. If you're offline, don't worry. Your notes are cached locally, so you can keep working. Once you're back online, everything syncs up automatically. And if you've got large images or attachments in your workspace, iCloud prioritizes them based on what you're actively using. ### When Conflicts Happen Edit the same note on two devices while offline? iCloud creates conflict copies with timestamps in the filename. You'll see both versions in Octarine's file tree. Just review them, merge any changes you want to keep, and delete the conflict copy. The file tree updates automatically once you're done. ### Things to Keep in Mind The first time you open a large workspace, it might take a bit for everything to sync—especially if you've got a lot of attachments. After that, though, changes usually show up on other devices within seconds. Just make sure you have enough iCloud storage available and a decent internet connection. ### When Sync Isn't Working If your notes aren't syncing, here's what to check: - **Check iCloud Drive is enabled** in System Settings - **Verify storage space** — if you're out of space, nothing new will sync - **Force a sync** by right-clicking your workspace folder in Finder and selecting "Download Now" - **Refresh the file tree** by clicking the refresh icon in Octarine's toolbar - **Confirm internet connection** is active ### Platform Notes On macOS, you get full two-way sync with immediate updates. If you need to check your notes from a browser, you can view them (but not edit) at icloud.com. #### Quick Answers ### Can I use iCloud Drive with Octarine? Yes. Put your Octarine workspace in iCloud Drive and iCloud will sync the workspace files across devices signed in with your Apple ID. ### Does Octarine store notes directly in iCloud? Octarine stores notes in the workspace folder you choose. If that folder is inside iCloud Drive, iCloud handles syncing. ### What should I do if iCloud notes are missing after restart? Wait for iCloud Drive to finish downloading, choose **Download Now** in Finder if available, and refresh or reopen the workspace in Octarine. -------------------------------------------------------------------------------- title: "Syncthing" description: "Backup your workspace with Syncthing" source: "https://docs.octarine.app/backup/syncthing" -------------------------------------------------------------------------------- # Syncthing Want to keep your notes synced across devices without relying on cloud services? Syncthing is an open-source, peer-to-peer sync tool that keeps your files synchronized directly between your own devices—no third-party servers involved. It's perfect if you value privacy and want complete control over your data. ### What is Syncthing? Syncthing is a continuous file synchronization program that runs on your devices and syncs folders directly between them over your local network or the internet. Unlike cloud services, your files never touch someone else's servers—they go straight from one of your devices to another, encrypted in transit. It's free, open-source, and works on Windows, macOS, Linux, Android, and more. Once set up, it runs in the background and keeps your Octarine workspace in sync automatically. ### Setting Up Syncthing 1. **Install Syncthing** on all devices you want to sync — download from the [Syncthing website](https://syncthing.net/) 2. **Open the web interface** at `http://localhost:8384` in your browser 3. **Add devices:** - Find your Device ID in the Syncthing interface on each device - Click "Add Remote Device" on your other devices and paste the ID - Do this on both sides (e.g., add desktop's ID on laptop, and vice versa) 4. **Share your workspace folder:** - Click "Add Folder" in Syncthing's interface - Navigate to your Octarine workspace - Give it a label (like "Octarine Notes") - Choose which devices to share it with - Select "Send & Receive" mode for two-way sync 5. **Repeat on all devices** — point to the same workspace location and Syncthing will start syncing immediately ### How It Works Once configured, Syncthing runs continuously in the background, watching for changes in your workspace folder. When you save a note in Octarine, Syncthing detects the change and pushes it to your other devices within seconds (assuming they're online). Unlike cloud sync, Syncthing is peer-to-peer. If both your laptop and desktop are on the same network, files sync directly between them—fast and private. If one device is offline, Syncthing waits until it comes back online and then syncs the changes. ### Things to Know **File conflicts:** If you edit the same note on two devices while they're offline, Syncthing creates a conflict copy with a timestamp in the filename. You'll see both versions in Octarine's file tree—just review them, merge any changes, and delete the conflict copy. **Versioning:** Syncthing supports versioning, so if you accidentally delete or overwrite a file, you can recover previous versions. You'll need to enable this in the folder settings (look for "File Versioning" and choose a method like "Simple File Versioning" or "Staggered File Versioning"). **Performance:** The first sync can take a while if you have a large workspace, but after that, Syncthing only syncs changes, so it's fast. It uses minimal resources and runs quietly in the background. ### When Things Don't Sync If your notes aren't syncing, here's what to check: - **Check Syncthing is running** on all devices (look for the icon in your system tray or menu bar) - **Verify devices are connected** — they should show as "Connected" in the web interface - **Enable Relay** in settings if devices are on different networks - **Check firewall settings** — review Syncthing logs for connection errors - **Refresh the file tree** by clicking the refresh icon in Octarine's toolbar ### Why Choose Syncthing? Syncthing is great if you want: - **Privacy:** Your files never leave your devices except to go to your other devices. - **No storage limits:** You're only limited by the space on your own devices. - **No subscription fees:** It's completely free and open-source. - **Control:** You decide what syncs, when, and with which devices. It takes a bit more setup than a cloud service, but once it's running, it's rock-solid and completely private. #### Quick Answers ### Can I sync Octarine with Syncthing? Yes. Share your Octarine workspace folder in Syncthing and it will synchronize the Markdown files directly between your devices. ### Does Syncthing upload my notes to a cloud server? No. Syncthing syncs peer to peer between your devices, with files encrypted in transit. ### What happens if I edit the same note on two Syncthing devices? Syncthing creates a conflict copy with a timestamp. Review both files in Octarine, merge what you need, and delete the conflict copy. -------------------------------------------------------------------------------- title: "URI Scheme" description: "URI scheme for deep linking to notes and actions, with support for external automations and x-callback-url integrations." source: "https://docs.octarine.app/workflows/uri-scheme" -------------------------------------------------------------------------------- # URI Scheme Octarine supports deep links via the `octarine://` URL scheme (or `octarine-staging://` for staging builds). These allow external tools like Raycast, Alfred, Shortcuts, and AI assistants (Claude, ChatGPT) to interact with your notes. ## URL Format ```plaintext octarine://?param1=value1¶m2=value2 ``` Or with explicit action parameter: ```plaintext octarine://host?action=¶m1=value1 ``` ## x-callback-url Support Octarine supports the [x-callback-url](http://x-callback-url.com/) specification, allowing external apps to receive results from Octarine actions. ### Callback Parameters | Parameter | Description | | --- | --- | | `x-success` | URL to open on successful completion | | `x-error` | URL to open if an error occurs | | `x-cancel` | URL to open if the operation is cancelled | | `x-source` | Name of the calling app (optional, for display) | ### Success Callback Data On success, Octarine appends result data to the `x-success` URL: | Action | Data Appended | | --- | --- | | `open` | `path`, `workspace` | | `create` | `path`, `workspace`, `action` (created/appended/replaced) | | `daily` | `path`, `date` or `week`, `workspace`, `action` | | `search` | `query`, `workspace` | | `getCurrentNote` | `url`, `title` | ### Error Callback Data On error, Octarine appends to the `x-error` URL: - `errorCode` - Machine-readable error code - `errorMessage` - Human-readable error description ### Error Codes | Code | Description | | --- | --- | | `workspace_not_found` | Specified workspace doesn't exist | | `file_not_found` | File path doesn't exist | | `missing_parameter` | Required parameter not provided | | `invalid_date` | Could not parse date/week format | | `save_failed` | Failed to save file | | `unknown_action` | Unrecognized action | ### Example with Callbacks **Apple Shortcuts - Run another shortcut on success:** ```plaintext octarine://create?path=inbox/note&content=Hello&x-success=shortcuts://run-shortcut?name=NoteCreated # On success, runs the "NoteCreated" shortcut with parameters: shortcuts://run-shortcut?name=NoteCreated&path=inbox/note.md&workspace=Personal&action=created ``` **Apple Shortcuts - Open a URL on success:** ```plaintext octarine://daily?date=today&content=Task%20complete&x-success=https://example.com/webhook?status=done # On success, opens in browser: https://example.com/webhook?status=done&path=Daily/2026-01-06.md&action=appended ``` **Generic webhook on error:** ```plaintext octarine://create?path=important/note&content=Data&x-error=https://example.com/alert?type=octarine-error # On error, calls: https://example.com/alert?type=octarine-error&errorCode=save_failed&errorMessage=Error%20saving%20file ``` --- ## Common Parameters These parameters are available across most actions: | Parameter | Type | Description | | --- | --- | --- | | `workspace` | string | Workspace name to target. If omitted, uses current workspace. | | `compressedContent` | string | LZ-String base64 compressed content (for large payloads) | --- ## Actions ### `open` - Open an existing note Opens a specific note file in a new tab. **Parameters:** | Parameter | Required | Type | Description | | --- | --- | --- | --- | | `path` | Yes | string | Path to the note (relative to workspace root) | | `workspace` | No | string | Target workspace name | **Examples:** ```plaintext # Open a note in current workspace octarine://open?path=notes/meeting.md # Open a note in a specific workspace octarine://open?path=Projects/roadmap.md&workspace=Work # Path without .md extension (auto-added) octarine://open?path=inbox/quick-note ``` **Behavior:** - Navigates to the workspace notes view - Opens the file in a new tab - If file doesn't exist, tab will show empty/error state --- ### `search` - Execute a search query Opens the search drawer with a pre-filled query. **Parameters:** | Parameter | Required | Type | Description | | --- | --- | --- | --- | | `query` | Yes | string | Search query text | | `workspace` | No | string | Target workspace name | **Examples:** ```plaintext # Search in current workspace octarine://search?query=project%20alpha # Search with special characters (URL encoded) octarine://search?query=%23todo%20urgent # Search in specific workspace octarine://search?query=meeting%20notes&workspace=Work ``` **Behavior:** - Opens the sidebar - Opens the search drawer - Pre-fills the search query - Search is case-insensitive by default --- ### `daily` - Open a daily or weekly note Opens the daily or weekly note for a specific date. Supports natural language dates and ISO week format. Can optionally add content to the note. **Parameters:** | Parameter | Required | Type | Default | Description | | --- | --- | --- | --- | --- | | `date` | Yes | string | \- | Date (YYYY-MM-DD), week (YYYY-Www), or natural language | | `content` | No | string | \- | Content to add to the note | | `template` | No | string | \- | Template name to use as initial content | | `fresh` | No | `true` | `false` | `false` | | `position` | No | `top` | `bottom` | `bottom` | | `separator` | No | string | `\n\n` | Separator between existing and new content | | `openAfter` | No | `true` | `false` | `true` | | `workspace` | No | string | current | Target workspace name | **Supported Date Formats:** - ISO date: `2024-01-15`, `2024-12-25` - ISO week: `2024-W03`, `2026-W1` - Natural language dates: `today`, `yesterday`, `tomorrow` - Relative dates: `2 days ago`, `next monday`, `last friday` - Partial dates: `jan 15`, `december 25`, `nov 3` - Natural language weeks: `this week`, `last week`, `next week` - Relative weeks: `2 weeks ago`, `in 2 weeks` **Examples:** ```plaintext # Today's daily note (just open) octarine://daily?date=today # Yesterday's note octarine://daily?date=yesterday # Specific date octarine://daily?date=2024-01-15 # Natural language octarine://daily?date=last%20friday octarine://daily?date=2%20days%20ago # Weekly notes (ISO week format) octarine://daily?date=2024-W03 octarine://daily?date=2026-W1 # Natural language weeks octarine://daily?date=this%20week octarine://daily?date=last%20week octarine://daily?date=2%20weeks%20ago # Add content to today's note (appends if exists, creates if not) octarine://daily?date=today&content=Remember%20to%20call%20Mom # Add content to top of daily note octarine://daily?date=today&content=%23%23%20Morning%20Entry&position=top # Replace daily note content entirely octarine://daily?date=today&content=Fresh%20start&fresh=true # Add to weekly note without opening octarine://daily?date=this%20week&content=Weekly%20goal&openAfter=false # Create daily note using a template octarine://daily?date=today&template=daily-template # Create weekly note using a template octarine://daily?date=this%20week&template=weekly-review ``` **Behavior:** - For dates: Opens/creates `Daily/YYYY-MM-DD.md` - For weeks: Opens/creates `Daily/Weekly/YYYY-WNN.md` - If `content` provided: auto-appends to existing file or creates new file - If `template` provided: uses template content (takes priority over `content`) - If `fresh=true`: replaces existing content instead of appending - When `position=top`, preserves frontmatter at the top and inserts after it --- ### `create` - Create or update a note Creates a new note or updates an existing one. By default, appends content to existing files (upsert behavior). To clip the **current webpage** from Safari, Chrome, or Firefox, use the [Web clip bookmarklet](https://docs.octarine.app/docs/workflows/web-clip-bookmarklet). **Parameters:** | Parameter | Required | Type | Default | Description | | --- | --- | --- | --- | --- | | `path` | Yes | string | \- | Path for the note (relative to workspace) | | `content` | No | string | "" | Content for the note | | `contentReference` | No | string | \- | URL or file path to fetch content from | | `template` | No | string | \- | Template name to use as initial content | | `compressedContent` | No | string | \- | LZ-String base64 compressed content | | `fresh` | No | `true` | `false` | `false` | | `position` | No | `top` | `bottom` | `bottom` | | `separator` | No | string | `\n\n` | Separator between existing and new content | | `openAfter` | No | `true` | `false` | `true` | | `workspace` | No | string | current | Target workspace name | **Examples:** ```plaintext # Create empty note (or open if exists) octarine://create?path=inbox/new-idea # Create with content (appends if file exists) octarine://create?path=inbox/task&content=%23%20New%20Task%0A%0A-%20%5B%20%5D%20Item%201 # Create from URL content octarine://create?path=imports/article&contentReference=https://example.com/doc.md # Add to top of note octarine://create?path=inbox/updates&content=%23%23%20Update&position=top # Add content without opening octarine://create?path=inbox/quick&content=Note&openAfter=false # Replace file content entirely octarine://create?path=inbox/draft&content=Starting%20over&fresh=true # Create in specific workspace octarine://create?path=Projects/feature&content=Feature%20spec&workspace=Work # Create note using a template octarine://create?path=meetings/standup&template=meeting-notes # Template with .md extension also works octarine://create?path=projects/new-project&template=project-template.md ``` **Behavior:** - Auto-adds `.md` extension if not present - **Upsert by default**: Creates file if doesn't exist, appends if it does - With `fresh=true`: Replaces existing content entirely - When `position=top`, preserves frontmatter at the top and inserts after it - Shows toast notification with result ("Created", "Appended to", or "Replaced") **Content Priority:** When multiple content sources are provided, they are resolved in this order: 1. `template` - If provided and template exists, uses template content 2. `contentReference` - If no template match, fetches from URL/file 3. `content` - Falls back to inline content parameter **Use Case - AI Update List:** ```plaintext # Claude adding an update (auto-appends to existing) octarine://create?path=inbox/claude-updates&content=%23%23%20Jan%203%2C%202026%0A%0A-%20Completed%20feature%20X&position=top ``` **Use Case - Daily Standup Template:** ```plaintext # Replace with fresh template each day octarine://create?path=work/standup&content=%23%20Standup%0A%0A%23%23%20Yesterday%0A%0A%23%23%20Today%0A%0A%23%23%20Blockers&fresh=true ``` --- ### `getCurrentNote` - Get the currently open note Returns the URL and title of the currently focused note via x-callback-url. This is designed for integration with tools like [Hookmark](https://hookproductivity.com/) that need to query the active document. **Parameters:** | Parameter | Required | Type | Description | | --- | --- | --- | --- | | `x-success` | Yes | string | Callback URL to receive the note's URL and title | | `x-error` | No | string | Callback URL for errors | | `workspace` | No | string | Target workspace name (defaults to current) | **Callback Data:** On success, appends to `x-success`: | Parameter | Description | | --- | --- | | `url` | Full `octarine://open?path=...&workspace=...` URL for the note | | `title` | Display title of the note | **Examples:** ```plaintext # Get current note info (generic callback) octarine://getCurrentNote?x-success=myapp://callback # Hookmark integration octarine://getCurrentNote?x-success=hookmark://x-callback-url/setBookmark # Test with a local server octarine://getCurrentNote?x-success=http://localhost:9999/callback # Apple Shortcuts integration octarine://getCurrentNote?x-success=shortcuts://x-callback-url/run-shortcut?name=HandleNote ``` **Behavior:** - Looks up the currently focused tab in the active workspace - Returns the note's `octarine://open` URL and display title via x-callback-url - If no note is open, calls `x-error` with `file_not_found` error code - If no workspace is available, calls `x-error` with `workspace_not_found` error code - Does not open or modify any notes — read-only action **Hookmark Integration:** To set up Hookmark with Octarine, use `getCurrentNote` as the "Get Address" script target. Hookmark will call the URL and receive back the note's address and title, enabling bidirectional linking between Octarine notes and any other Hookmark-supported app. --- ## URL Encoding Special characters must be URL-encoded: | Character | Encoded | | --- | --- | | Space | `%20` | | Newline | `%0A` | | `#` | `%23` | | `/` | `%2F` | | `?` | `%3F` | | `&` | `%26` | | `=` | `%3D` | **Example with markdown content:** ```plaintext # Original content: ## Heading - Item 1 - Item 2 # URL encoded: octarine://create?path=test&content=%23%23%20Heading%0A%0A-%20Item%201%0A-%20Item%202 ``` --- ## Large Content: LZ-String Compression For large content that might exceed URL length limits, use LZ-String base64 compression: ```javascript const content = "# Very long document..."; const compressed = LZString.compressToBase64(content); const url = `octarine://create?path=doc&compressedContent=${encodeURIComponent( compressed )}`; ``` --- ## Integration Examples ### Shell Script - Daily Log ```bash #!/bin/bash # Append timestamped entry to daily log TIMESTAMP=$(date "+%H:%M") ENTRY="- [$TIMESTAMP] $1" ENCODED=$(python3 -c "import urllib.parse; print(urllib.parse.quote('$ENTRY'))") open "octarine://daily?date=today&content=$ENCODED&openAfter=false" ``` ### Shell Script - Quick Capture ```bash #!/bin/bash # Add quick note to inbox NOTE_CONTENT="$1" ENCODED=$(python3 -c "import urllib.parse; print(urllib.parse.quote('$NOTE_CONTENT'))") open "octarine://create?path=inbox/quick-capture&content=$ENCODED&openAfter=false" ``` ### Browser Bookmarklet ```javascript // Save page info as a note (add as bookmark URL) javascript: (function () { const title = document.title.replace(/[^a-zA-Z0-9 ]/g, ""); const content = `# ${document.title}\n\nURL: ${ window.location.href }\n\nSaved: ${new Date().toISOString()}`; window.location.href = `octarine://create?path=web-clips/${encodeURIComponent( title )}&content=${encodeURIComponent(content)}`; })(); ``` ### Browser Bookmarklet - Save Selection ```javascript javascript: (function () { const sel = window.getSelection().toString(); if (!sel) { alert("Select some text first"); return; } const content = `# Clip from ${document.title}\n\nSource: ${window.location.href}\n\n> ${sel}`; window.location.href = `octarine://create?path=inbox/web-clip&content=${encodeURIComponent( content )}`; })(); ``` ### Claude/AI Assistant ```plaintext To save this information to your notes, use: octarine://create?path=inbox/ai-research&content=%23%23%20Research%20Summary%0A%0A...&position=top ``` ### AppleScript - Capture from Any App ```applescript -- Save clipboard to daily note set clipContent to the clipboard as text set encodedContent to do shell script "python3 -c \"import urllib.parse; print(urllib.parse.quote('" & clipContent & "'))\"" open location "octarine://daily?date=today&content=" & encodedContent & "&openAfter=false" ``` ### PopClip Extension (macOS) ```yaml # Config.yaml for PopClip extension name: Save to Octarine icon: square and pencil url: octarine://create?path=inbox/popclip&content=*** ``` ## Error Handling All actions show toast notifications for: - Success: Green toast with action confirmation ("Created", "Appended to", "Replaced") - Error: Red toast with error message Common errors: - "Workspace not found" - Invalid workspace name - "File not found" - Path doesn't exist (for `open` action) - "No note is currently open" - No focused tab (for `getCurrentNote` action) - "Could not parse date" - Invalid date format (for `daily` action) - "Missing X parameter" - Required parameter not provided - "Error saving file" - File system error during save - "Invalid deep link URL format" - Malformed URL --- ## Platform Notes | Platform | URL Scheme Registration | | --- | --- | | macOS | Automatic via Info.plist | | Windows | Runtime registration on app start | | Linux | Runtime registration on app start | The deep link handler has a 1-second debounce to prevent duplicate executions when the same URL is triggered multiple times rapidly. --- ## Copying Octarine URLs You can copy the Octarine URL for any note using: 1. **Command Bar** (Cmd+K): Search for "Copy Octarine URL" 2. **Note Menu**: Click the settings icon in the note breadcrumb -> "Copy Octarine URL" The copied URL format: ```plaintext octarine://open?path=notes%2Fmeeting.md&workspace=My%20Workspace ``` ## Best Practices ### URL Stability - **Use relative paths**: Octarine URLs use paths relative to the workspace root, so they survive workspace folder moves - **Include workspace name**: For multi-workspace setups, always include the `workspace` parameter - **Use URL encoding**: Always encode special characters, especially spaces, newlines, and `#` ### Performance - **Use** `openAfter=false` for background operations when you don't need to see the result - **Batch operations**: For multiple entries, consider building content in your script and doing one create - **Use** `fresh=true` sparingly - only when you intentionally want to replace content ### Content Behavior - **Default is upsert**: `create` and `daily` actions auto-append to existing files - **Use** `fresh=true` to replace content entirely (e.g., regenerating a template) - **Use** `position=top` for reverse-chronological logs (newest first) - **Use** `position=bottom` (default) for chronological logs ### Error Handling - All deep link actions show toast notifications for success/failure - Use `x-error` callback to handle errors programmatically - Use `x-success` callback to chain actions or confirm completion - Invalid workspaces or paths result in error toasts ### Security - Deep links can only access workspaces configured in Octarine - No access to arbitrary filesystem paths outside workspaces - Content is never executed, only inserted as text #### Quick Answers ### Does Octarine support deep links? Yes. Octarine supports the `octarine://` URI scheme for opening notes, creating content, daily notes, and automation callbacks. ### Can Octarine deep links access arbitrary files? No. Deep links can only access workspaces already configured in Octarine. ### How do I copy an Octarine URL for a note? Use **Copy Octarine URL** from the Command Bar or the note breadcrumb menu. -------------------------------------------------------------------------------- title: "Hookmark" description: "Connect Hookmark to Octarine so Hookmark can link to the currently focused note." source: "https://docs.octarine.app/workflows/hookmark" -------------------------------------------------------------------------------- # Hookmark Hookmark can link to Octarine notes through Octarine's [`octarine://`](https://docs.octarine.app/docs/workflows/uri-scheme) URL scheme. Octarine exposes a `getCurrentNote` action that returns the current note title and an Octarine URL through Hookmark's x-callback-url flow. ## Add the Hookmark script Open Hookmark's script editor and add a **Get Address** script for Octarine. Use this script: ```applescript set callbackURL to "hook://x-callback-url/setCurrentNode%3FrequestID%3D$requestID" set callbackURLError to "hook://x-callback-url/setCurrentNodeError" set myURL to "octarine://getCurrentNote?x-success=" & callbackURL & "&x-error=" & callbackURLError set myScript to "open " & quoted form of myURL do shell script myScript return callbackURL ``` After saving the script, focus an open note in Octarine and use Hookmark's shortcut. Hookmark should show the current note title and let you copy or hook the note. ## Fallback: copy a Markdown link If you prefer a clipboard-based workflow, use **Copy Octarine URL in Markdown** from Octarine's command menu. This copies a link like: ```markdown [Note title](octarine://open?path=Notes%2FExample.md&workspace=Personal) ``` You can assign this Octarine command to a keyboard shortcut and call it from Hookmark if your Hookmark setup relies on copying a Markdown link. ## Troubleshooting If Hookmark says **No linkable item found**, it usually means Hookmark is not running an Octarine Get Address script yet. Octarine can still be checked directly from Terminal: ```sh open 'octarine://getCurrentNote?x-success=http%3A%2F%2F127.0.0.1%3A9999%2Fcallback' ``` That command needs a local callback listener to receive the response, but it is useful when testing whether Octarine is handling the URL scheme. #### Quick Answers ### Can Hookmark link to Octarine notes? Yes. Hookmark can use Octarine's `octarine://` URL scheme and `getCurrentNote` action to link to the focused note. ### What Octarine command works as a Hookmark fallback? Use **Copy Octarine URL in Markdown** if your Hookmark workflow is clipboard-based. ### What should I check if Hookmark says no linkable item found? Make sure Hookmark has a Get Address script for Octarine and that a note is focused in Octarine. -------------------------------------------------------------------------------- title: "Web clip bookmarklet" description: "Save the active browser tab as a markdown note in Octarine using a bookmark—no extension required." source: "https://docs.octarine.app/workflows/web-clip-bookmarklet" -------------------------------------------------------------------------------- # Web clip bookmarklet This flow is for **Octarine on the desktop**. It relies on the [`octarine://`](https://docs.octarine.app/docs/workflows/uri-scheme) URL scheme, which the app registers when installed. ## Installer page *Last Updated: July 10, 2026* Open the **[bookmarklet installer](https://docs.octarine.app/octarine-save-bookmarklet.html)** — a plain HTML page served from this site (`public/octarine-save-bookmarklet.html`). Drag **Save to Octarine** onto your bookmarks bar. Use the folder field if you want clips somewhere other than `web-clips/`; the choice is stored in that browser. Then open the article or page you care about and click the bookmark. Octarine should open with a new note created via [`create`](https://docs.octarine.app/docs/workflows/uri-scheme#create---create-or-update-a-note) (`fresh=true`). ## Limits - Bookmarklets depend on the browser: some profiles or browsers block or strip `javascript:` bookmarks. - Sites with a tight **Content Security Policy** may refuse to run a bookmarklet on that tab. #### Quick Answers ### Can Octarine save web pages without a browser extension? Yes. Use the Save to Octarine bookmarklet to create a Markdown note from the active browser tab. ### Where do web clips go by default? The bookmarklet defaults to `web-clips/` unless you choose another folder on the installer page. ### Why might the bookmarklet fail on some sites? Some browsers or site Content Security Policies block bookmarklets, so the script may not run on every page. -------------------------------------------------------------------------------- title: "Default Folder Location" description: "Set the default location for where new notes are to be created" source: "https://docs.octarine.app/workflows/default-folder" -------------------------------------------------------------------------------- # Default Folder Location You can now set a default folder where all new notes are created. This is configured per-workspace in `Settings > Files` **How it works** | Scenario | Where the note is created | | --- | --- | | No default folder set, no folder selected in sidebar | Workspace root | | No default folder set, folder selected in sidebar | The selected folder | | No default folder set, current note tab is inside a folder | The selected folder | | Default folder set, no folder selected | The default folder | | Default folder set, folder selected in sidebar | The default folder (overrides selection) | | Default folder cleared (set back to Root) | Behaves as if no default is set (cases 1 & 2) | **Key details** - Cmd+N always creates notes in the default folder when one is set, regardless of what's selected in the sidebar. - The "New Note" button tooltip updates to reflect where the note will be created. - Dot-folders (e.g. .hidden) are excluded from the folder picker. - The setting can be cleared with the Clear button to revert to the default behavior. > Available only on the Pro License #### Quick Answers ### Can I choose where new notes are created? Yes. Set a default folder in `Settings -> Files` so new notes are created there automatically. ### Does the default folder override the selected sidebar folder? Yes. When a default folder is set, new notes go there even if another folder is selected. ### Does default folder location require Pro? Yes. Default folder location is available with a Pro license. -------------------------------------------------------------------------------- title: "Inbox" description: "Triage Markdown captures stored under .octarine/inbox until you resolve or promote them into your workspace notes." source: "https://docs.octarine.app/workflows/inbox" -------------------------------------------------------------------------------- # Inbox **Inbox requires a Pro license** on desktop. Captures stay on your machine as markdown under **`.octarine/inbox/`** inside the workspace—plain files next to your notes so sync and backups behave like everything else. To **record** captures from anywhere, see [Quick Capture](https://docs.octarine.app/docs/workflows/quick-capture). For swipe-based triage and Capture Tags chips on mobile, see [Inbox & Quick Capture on iOS](https://docs.octarine.app/docs/iOS/inbox). ## Opening the inbox Choose **Inbox** from the workspace sidebar or open it as its own editor tab. Active (non-done) items show a badge count on the Inbox shortcut. On a narrow window you get a single column; widen the inbox view and Octarine splits into **list + detail** so you can scan and edit side by side. ## Triage lanes New captures appear in the inbox list grouped for triage (**Open**, **In progress**, **Cold box**, **Done**): - **Open** — actionable, not snoozed. - **In progress** — you marked the capture as currently being worked. - **Cold box** — snoozed with a wake time (`snoozed_until`) still in the future. - **Done** — resolved, converted to a note, appended to a daily note, or explicitly marked done. ## Tags on captures (desktop) When saving from Quick Capture to **Inbox**, you can attach up to **five** tags (`#`-style labels) drawn from tags already present in your workspace index, or add new normalized tags from the picker. Those tags are persisted in YAML frontmatter on the capture file. ## Triage actions Typical workflows from inbox item detail: - **Mark done**, **re-open**, progress states, priorities, pinning, snooze (with presets such as later today, this evening / tomorrow evening, tomorrow morning, this weekend, next week—each shows the computed date/time). - **Convert to note** — creates a normal markdown note under a folder you pick, merges capture metadata where appropriate, and marks the inbox item resolved with linkage back (`converted_to`). - **Append to today’s daily** — merges the capture body into the current daily note, then clears it from active triage (`appended_to`). Searching the inbox scans capture bodies across states when needed. ## On disk Each capture is a markdown file—for example **`{workspace}/.octarine/inbox/YYYY-MM-DD_HH-mm-ss-SSS.md`**—with YAML frontmatter for triage (`priority`, `tags`, `done`, `snoozed_until`, inbox number, timestamps, provenance). ## Snoozed items Until the snooze expiry passes, captures sit in **Cold box** / snoozed grouping and disappear from immediate open lists. Clearing snooze wakes them instantly. #### Quick Answers ### Where are Octarine inbox captures stored? Inbox captures are Markdown files stored under `.octarine/inbox/` inside your workspace. ### Does Inbox require Octarine Pro? Yes. Inbox requires a Pro license on desktop. ### Can I turn an inbox capture into a normal note? Yes. Use **Convert to note** to create a normal Markdown note and mark the inbox item as resolved. -------------------------------------------------------------------------------- title: "Quick Capture" description: "A compact floating window to jot into your Inbox or append to today’s daily note using global shortcuts or the menu." source: "https://docs.octarine.app/workflows/quick-capture" -------------------------------------------------------------------------------- # Quick Capture **Quick Capture requires a Pro license** on desktop. For the iOS sheet experience, see [Inbox & Quick Capture on iOS](https://docs.octarine.app/docs/iOS/inbox). After you save to the inbox, items show up in the desktop [Inbox](https://docs.octarine.app/docs/workflows/inbox) for triage. ## Opening Quick Capture Quick Capture opens a compact **popover window** wired to your active workspace (one instance reused on macOS after it is warmed up). Trigger it from the **Octarine menu** (Quick Capture) or with the **global shortcut** when licensed: | Platform | Shortcut | |-----------------|-----------------------------------| | macOS | ⌃⌥ Space (Control–Option–Space) | | Windows / Linux | Ctrl+Alt+Space | ## Inside the window - **Destination**: switch between **Inbox** and today’s **Daily** note from the header, or toggle with **⌘⇧J** on macOS / **Ctrl+Shift+J** on Windows & Linux. Sending to inbox records metadata suitable for triage (`source: quick_capture` among other fields). Sending to the daily note appends a block—optionally with a timestamp line beforehand. - **Title** (optional) refines list labels in Inbox and headings when you append to the daily note; Inbox mode focuses the title field first, while daily mode focuses the editor for faster typing. - **Body**: full rich-text surface; Inbox mode still supports priorities and tags from the footer row. - **Clipboard**: paste with **⌘V / Ctrl+V**. When focus is in the capture **title** field—or anywhere outside the editing surface—Octarine inserts clipboard content programmatically (HTML where available, otherwise plain text capped for safety). When the cursor is **inside** the capture editor, **⌘V / Ctrl+V** uses the native editor paste path so embedded images continue to work. A lone URL shows a subtle hint banner so you remember it lands as literal text unless you embellish it. - **Submit**: **⌘Enter / Ctrl+Enter** submits when there is body text (same chord as **Capture** in the footer). After a successful save to the inbox path, Quick Capture hides and, on macOS, can deactivate the Octarine foreground so whatever app was behind it returns to focus—which makes “dump thought and go back” feel instant. ## Settings Daily-only behavior is tuned under **workspace Settings → Quick capture** (**Timestamp before daily captures**). #### Quick Answers ### What is Quick Capture? Quick Capture is a compact popover for quickly saving text to your Inbox or appending it to today's daily note. ### What is the Quick Capture shortcut? On macOS, use `Control-Option-Space`. On Windows and Linux, use `Ctrl+Alt+Space`. ### Does Quick Capture require Pro? Yes. Quick Capture requires a Pro license on desktop. -------------------------------------------------------------------------------- title: "Obsidian" description: "Quickly setup your existing Obsidian vault as a workspace in Octarine" source: "https://docs.octarine.app/importing/obsidian" -------------------------------------------------------------------------------- # Obsidian Moving from Obsidian to Octarine? Since both apps use standard markdown files stored locally, migration is pretty straightforward. You can turn your existing vault into an Octarine workspace with just a few adjustments. ### Direct Migration The quickest way is to create a workspace from your existing Obsidian vault: Open Octarine and click the **Workspace Switcher** in the top-left corner. Select **Create Workspace**, give it a name, and toggle **Use an existing folder?**. Navigate to your Obsidian vault and press Create. That's it—Octarine will start using your vault as a workspace. ### Adjusting the Folder Structure Octarine has a few conventions that might differ from your Obsidian setup. Here's what to check: **Attachments:** If your vault uses a different attachment folder, create a `.attachments` folder in your vault root and move all images and media there. Octarine expects attachments to be referenced as `[[filename.png]]`, so you might need to update some links. **Linked Notes:** Obsidian gives you options for how to store wikilinks, but Octarine is stricter. Notes need to include the entire path (except the workspace path) in the link. For example, a note called `Hello` inside a folder called `New Folder` should be linked as `[[New Folder/Hello]]`. If you just write `[[Hello]]`, Octarine will look for it in the root folder, not in nested folders. **Templates:** If you use templates, create a `.templates` folder in your vault root and move your template files there. **Daily Notes:** If your daily notes aren't already in a `Daily` folder, create one and move them there. Make sure they follow the `YYYY-MM-DD.md` naming format so Octarine can recognize them. ### Compatibility Notes Octarine supports Obsidian's `[[wikilink]]` syntax natively, though aliases aren't supported yet. Absolute paths are required for storage, but you can change the setting for how they're displayed in the UI. Tags work seamlessly—both `#tag` and `#nested/tag` formats are fully supported. #### Quick Answers ### Can Octarine open an Obsidian vault? Yes. You can create an Octarine workspace from an existing Obsidian vault because both apps use local Markdown files. ### Do Obsidian wikilinks work in Octarine? Octarine supports Obsidian-style `[[wikilink]]` syntax, but links should include the full path inside the workspace so Octarine can resolve nested notes reliably. ### Do I need to export from Obsidian first? Usually no. If your vault is already a folder of Markdown files, point Octarine at the existing folder and adjust attachments, templates, and daily notes as needed. -------------------------------------------------------------------------------- title: "Apple Notes" description: "Export Apple Notes as Markdown and move them into Octarine" source: "https://docs.octarine.app/importing/apple-notes" -------------------------------------------------------------------------------- # Apple Notes Apple Notes can export notes as Markdown on supported versions of Notes. Export the notes you want to move, collect the generated Markdown files in a folder, then use that folder as an Octarine workspace. ### Export from Apple Notes On Mac, open Notes and select the note you want to move. Choose **File > Export as > Markdown**, pick a destination folder, and save the file. Repeat this for the notes you want to migrate. If you are moving a large library, export one folder or group of notes at a time so the exported files stay easy to organize. If you only see **File > Export as > PDF**, update macOS and Notes first. PDF exports are useful as read-only archives, but they are not a good editable format for Octarine. ### Create an Octarine Workspace Create a folder for the migrated notes, then move the exported Markdown files into it. If you exported notes in batches, create matching folders before moving the files so your Apple Notes organization carries over. Open Octarine and click the **Workspace Switcher** in the top-left corner. Select **Create Workspace**, give it a name, and toggle **Use an existing folder?**. Choose the folder that contains your exported Apple Notes files and press Create. ### Attachments Apple Notes can include images, scans, PDFs, links, and other attachments. After export, check whether Notes created linked files next to the Markdown file or embedded references inside the Markdown. Move exported images and files into a `.attachments` folder at the root of your Octarine workspace. Then update any Markdown links that still point to the old export location. For images, standard Markdown image links will work when the paths are correct: ```markdown [[whiteboard-sketch.png]] ``` For file attachments, you can also use Octarine wikilinks: ```markdown [[receipt.pdf]] [[meeting-scan.png]] ``` ### Folders and Links Apple Notes folders do not automatically become Octarine folders unless your export preserves that structure. If your exported files are flat, create folders in your Octarine workspace and move related notes into them. After moving notes into folders, check links between notes. Octarine supports `[[wikilink]]` syntax, but links should include the path from the workspace root when the target note lives inside a folder. ### Compatibility Notes Headings, lists, checklists, links, code blocks, and basic formatting should migrate well through Markdown. Apple Notes-specific features such as shared note permissions, pinned state, locked notes, smart folders, note colors, audio recordings, transcriptions, and collaboration history do not become Octarine settings. For important notes with scans, sketches, or rich attachments, compare the exported Markdown with the original note before deleting anything from Apple Notes. #### Quick Answers ### Can I migrate Apple Notes to Octarine? Yes. Export Apple Notes as Markdown, collect the exported files in a folder, and create an Octarine workspace from that folder. ### Can I use Apple Notes PDF exports in Octarine? PDF exports can be kept as read-only reference files, but Markdown exports are better if you want editable Octarine notes. ### Do Apple Notes folders transfer to Octarine? Only if your export preserves the folder structure. Otherwise, create folders in the Octarine workspace and move related Markdown files into them. -------------------------------------------------------------------------------- title: "Bear" description: "Move Bear notes into an Octarine workspace" source: "https://docs.octarine.app/importing/bear" -------------------------------------------------------------------------------- # Bear Bear can export notes as Markdown, which makes it a good fit for Octarine. The cleanest route is to export your notes from Bear, put the exported files in a folder, then use that folder as an Octarine workspace. ### Export from Bear On Mac, select the notes you want to move. To migrate everything, click **Notes** in Bear's sidebar and press `Cmd + A`. Then choose **File > Export Notes...** and select **Markdown**. Octarine does not import `.textbundle` files directly. If your notes include images or file attachments, you can export TextBundle as a temporary package, extract the Markdown and assets from it, then move the extracted files into your Octarine workspace. ### Create an Octarine Workspace Create a folder for the migrated notes, then move the exported Markdown files into it. Open Octarine and click the **Workspace Switcher** in the top-left corner. Select **Create Workspace**, give it a name, and toggle **Use an existing folder?**. Choose the folder that contains your exported Bear notes and press Create. ### Tags and Organization Bear uses tags instead of folders. If you keep tags during export, they will remain in the Markdown content and Octarine can read inline tags such as `#writing` or `#projects/client`. If you want a folder-based structure in Octarine, create folders in your migrated workspace and move the exported notes into them. Octarine will preserve that folder structure in the file tree. ### Attachments Move exported images and files into a `.attachments` folder at the root of your Octarine workspace. Then update image and attachment links so they point to the moved files. For images, standard Markdown image links will continue to work if the paths are correct. For attachment-style references in Octarine, use wikilinks such as: ```markdown [[diagram.png]] [[research.pdf]] ``` ### Compatibility Notes Bear's Markdown exports are generally portable, but some Bear-specific formatting may need a quick cleanup after migration. Check encrypted notes, sketches, rich embeds, and internal Bear links after import. If a note links to another Bear note, verify that the link points to the right Octarine note. Octarine supports `[[wikilink]]` syntax, but links should include the path from the workspace root when the target note lives inside a folder. #### Quick Answers ### Can I migrate Bear notes to Octarine? Yes. Export Bear notes as Markdown, place the files in a folder, and create an Octarine workspace from that folder. ### Do Bear tags work in Octarine? Bear tags that remain in the Markdown content can be read by Octarine as inline tags. ### Does Octarine import Bear TextBundle files directly? No. If you use TextBundle for attachments, extract the Markdown and assets first, then move them into your Octarine workspace. -------------------------------------------------------------------------------- title: "iA Writer" description: "Use an iA Writer folder as an Octarine workspace" source: "https://docs.octarine.app/importing/ia-writer" -------------------------------------------------------------------------------- # iA Writer iA Writer already works with Markdown files in normal folders, so migration can be as simple as opening the same folder in Octarine. If your iA Writer documents are stored in iCloud, Dropbox, Google Drive, OneDrive, or a local folder, you can turn that folder into an Octarine workspace. ### Direct Migration Find the folder you use as your iA Writer Library location. This might be a local folder on your device or a synced folder in a cloud drive. Open Octarine and click the **Workspace Switcher** in the top-left corner. Select **Create Workspace**, give it a name, and toggle **Use an existing folder?**. Choose your iA Writer folder and press Create. Octarine will index the Markdown files in that folder and show the same folder structure in the file tree. ### Exported Documents If you prefer not to use your live iA Writer folder, export or copy the files you want to migrate into a new folder first. Then create an Octarine workspace from that folder. Use `.md` files where possible. Octarine is built around Markdown notes, so PDF, Word, and HTML exports are better kept as reference files rather than primary notes. ### Images and Content Blocks iA Writer supports standard Markdown image links and its own Content Block syntax for including other files. Octarine supports Markdown image links, but Content Blocks are not treated as live embedded documents. Before moving over, check any lines that include files by path, such as: ```markdown /images/Diagram.png /Chapter 2.md ``` For images and media, move the files into a `.attachments` folder in your workspace and update the references. For separate Markdown documents, keep them as normal notes and link to them with wikilinks. ### Linked Notes iA Writer and Octarine both support wikilinks. After migration, open a few linked notes and confirm the links resolve correctly. Octarine expects links to include the path from the workspace root when the target note is inside a folder. For example, link to a note called `Draft` inside `Projects` as: ```markdown [[Projects/Draft]] ``` ### Compatibility Notes Hashtags, headings, lists, quotes, and most Markdown formatting should move cleanly. Smart folders, favorites, iA Writer preview templates, publishing accounts, and app-specific library settings do not transfer because they are not part of the Markdown files. #### Quick Answers ### Can Octarine open an iA Writer folder? Yes. If your iA Writer library is a folder of Markdown files, create an Octarine workspace from that folder. ### Do iA Writer wikilinks work in Octarine? Many wikilinks should work, but nested notes should include the path from the workspace root so Octarine can resolve them reliably. ### Do iA Writer Content Blocks transfer to Octarine? Not as live embedded documents. Convert important included files into normal notes, links, or attachments. -------------------------------------------------------------------------------- title: "UpNote" description: "Export UpNote notes as Markdown and move them into Octarine" source: "https://docs.octarine.app/importing/upnote" -------------------------------------------------------------------------------- # UpNote UpNote can export notes as Markdown, which gives you editable files that Octarine can use directly. Export notes as separate Markdown documents, then turn the export folder into an Octarine workspace. ### Export from UpNote On desktop, export the notes, notebook, or full library you want to move. - To export selected notes, select them in the note list and choose **Export**. - To export a notebook, use the notebook menu and choose **Export**. - To export everything on Mac, choose **File > Export all notes**. - To export everything on Windows, go to **Settings > General > Export all notes**. Choose **Markdown (.md)** and export notes as separate files when that option is available. ### Create an Octarine Workspace After the export finishes, open the exported folder in Finder or your file manager. If UpNote created one folder containing your notes and a `Files` folder for attachments, keep them together while you clean up paths. Open Octarine and click the **Workspace Switcher** in the top-left corner. Select **Create Workspace**, give it a name, and toggle **Use an existing folder?**. Choose the exported Markdown folder and press Create. ### Attachments UpNote stores exported images and attachments in a `Files` folder inside the export. Octarine's convention is `.attachments` at the workspace root. Rename or move `Files` to `.attachments`, then update any Markdown links that still point at the old folder name. For example: ```markdown ![Screenshot](Files/screenshot.png) ``` can become: ```markdown [[Screenshot.png]] ``` ### Notebooks and Nested Notes If UpNote exports notebooks as folders, Octarine will show those folders in the file tree. If your export is flat, create folders manually and move related notes into them. After moving notes into folders, check any internal note links. Octarine resolves wikilinks from the workspace root, so nested notes should be linked with their folder path. ### Compatibility Notes Basic Markdown formatting, headings, checklists, tables, and tags should migrate well. UpNote-specific features such as notebook metadata, note colors, pinned state, backlinks, and publishing settings do not transfer as Octarine settings. If a note relied heavily on rich formatting, compare it with the original after import and make small Markdown adjustments where needed. #### Quick Answers ### Can I migrate UpNote notes to Octarine? Yes. Export UpNote notes as separate Markdown files, then create an Octarine workspace from the export folder. ### Where do UpNote attachments go in Octarine? Move UpNote's exported `Files` folder to `.attachments` at the workspace root, then update links if needed. ### Do UpNote notebooks transfer to Octarine folders? If UpNote exports notebooks as folders, Octarine will show those folders in the file tree. If the export is flat, create folders manually. -------------------------------------------------------------------------------- title: "Craft" description: "Export Craft documents and use them in Octarine" source: "https://docs.octarine.app/importing/craft" -------------------------------------------------------------------------------- # Craft Craft can export documents as Markdown and TextBundle. Octarine uses Markdown files, so TextBundle is only useful as a temporary package for extracting embedded images and attachments. ### Export from Craft Open the Craft document or group of documents you want to move. Use the share or export menu and choose **Export As**. Choose **Markdown (.md)** for regular notes. If a document contains images or attachments, you can export **TextBundle (.textbundle)**, then extract the Markdown and bundled assets before moving them into Octarine. For a larger migration, export from the highest-level folder, space, or document collection that contains the notes you want to bring over. ### Create an Octarine Workspace Create a new folder for the exported files. If Craft exported a folder tree, keep that structure because Octarine can use it directly. Open Octarine and click the **Workspace Switcher** in the top-left corner. Select **Create Workspace**, give it a name, and toggle **Use an existing folder?**. Choose the exported Craft folder and press Create. ### Attachments Move exported images and files into a `.attachments` folder at the root of your Octarine workspace. Then update Markdown links so they point to the new location. If you exported TextBundle files, each bundle contains Markdown plus assets. Octarine does not import `.textbundle` files directly, so extract or copy the Markdown files into your workspace, then collect the bundled assets into `.attachments`. ### Documents, Cards, and Subpages Craft documents can contain nested cards, pages, and blocks that do not always map perfectly to plain Markdown. After export, review the generated files and decide whether nested content should stay in the same note or become separate notes. When splitting large exports, use wikilinks to reconnect related notes: ```markdown [[Project Brief]] [[Research/Interview Notes]] ``` ### Compatibility Notes Headings, lists, checklists, code blocks, quotes, and basic links should move cleanly. Craft-specific layout, page cards, comments, sharing state, and visual document styling do not become Octarine settings. If a Craft page was highly visual, keep a PDF export as an archival reference alongside the Markdown version. #### Quick Answers ### Can I migrate Craft documents to Octarine? Yes. Export Craft documents as Markdown, keep or clean up the exported folder structure, and create an Octarine workspace from it. ### Does Octarine import Craft TextBundle files directly? No. Use TextBundle only as a temporary package for extracting Markdown and assets. ### Do Craft cards and subpages map perfectly to Octarine? Not always. Review nested Craft content after export and decide whether it should stay in one note or become separate linked notes. -------------------------------------------------------------------------------- title: "Notion" description: "Export Notion pages as Markdown and CSV for Octarine" source: "https://docs.octarine.app/importing/notion" -------------------------------------------------------------------------------- # Notion Notion can export pages as **Markdown & CSV**. Octarine can use the Markdown files as notes, while exported CSV files are best kept as reference files or converted manually if you want them to become notes. ### Export from Notion Open the page or top-level section you want to migrate. Click the **...** menu in the top-right corner and choose **Export**. Choose **Markdown & CSV** as the export format. Turn on **Include subpages** if you want nested pages included as separate files, then export the ZIP file and unzip it. To export an entire workspace, go to **Settings > General > Export all workspace content** on desktop or web. Notion will email you a download link when the export is ready. ### Create an Octarine Workspace After unzipping the export, open the folder and inspect the generated files. Notion usually creates Markdown files for regular pages and CSV files for databases. Open Octarine and click the **Workspace Switcher** in the top-left corner. Select **Create Workspace**, give it a name, and toggle **Use an existing folder?**. Choose the unzipped Notion export folder and press Create. ### Databases and CSV Files Notion databases export as CSV files, often with Markdown files for database pages. Octarine does not turn CSV tables into native notes automatically. For database exports, you can: - Keep the CSV files as external reference files. - Convert important rows into Markdown notes manually. - Keep the page Markdown files and use properties or tags in Octarine to rebuild the parts you still need. ### Attachments Notion exports uploaded files and images alongside the generated Markdown. Move attachments into a `.attachments` folder at the root of your Octarine workspace, then update links if the paths changed. If you keep Notion's exported folder structure, image links may already work. The `.attachments` cleanup is mostly useful when you want the workspace to follow Octarine's normal conventions. ### Compatibility Notes Basic pages, headings, lists, checklists, links, and code blocks usually move well. Notion callouts may export as HTML because there is no direct Markdown equivalent, and database views, relations, rollups, comments, page permissions, automations, and synced blocks do not become Octarine features. For important dashboards or databases, keep the original Notion export ZIP as an archive until you have verified the migrated notes. #### Quick Answers ### Can I migrate Notion pages to Octarine? Yes. Export Notion as **Markdown & CSV**, unzip the export, and create an Octarine workspace from the exported folder. ### Do Notion databases become Octarine notes automatically? No. Notion databases export as CSV files and related Markdown pages. Keep CSV files as references or convert important rows manually. ### Do Notion comments, relations, and automations transfer to Octarine? No. Notion-specific database views, relations, comments, permissions, automations, and synced blocks do not become Octarine features. -------------------------------------------------------------------------------- title: "Agenda" description: "Move Agenda projects and notes into Octarine" source: "https://docs.octarine.app/importing/agenda" -------------------------------------------------------------------------------- # Agenda Agenda can export or copy notes in Markdown, but it is not a folder-first Markdown app. The best migration path is to export projects or selected notes in batches, then organize the exported Markdown files into an Octarine workspace. ### Export from Agenda Select the project, category, or notes you want to move. On Mac, use **File > Export** when available, or use **Edit > Copy As > Markdown** for selected notes. Agenda may not export the whole library as Markdown in one step, so plan to migrate one project or category at a time. For notes with images or attachments, TextBundle can be useful as a temporary export package, but you will need to extract the Markdown and assets before moving them into Octarine. ### Create an Octarine Workspace Create a migration folder and add each exported batch to it. A simple structure is: ```text Agenda Export/ Work/ Personal/ Archive/ ``` Open Octarine and click the **Workspace Switcher** in the top-left corner. Select **Create Workspace**, give it a name, and toggle **Use an existing folder?**. Choose your Agenda export folder and press Create. ### Dates and Projects Agenda's timeline, projects, and calendar links are part of Agenda's app model. In Octarine, represent the pieces you still need with folders, tags, note properties, or daily notes. For dated notes, consider moving them into the `Daily` folder and renaming them to Octarine's daily note format: ```text YYYY-MM-DD.md ``` ### Attachments Move exported images and files into a `.attachments` folder at the root of your Octarine workspace. Then update links in the Markdown files so they point to the moved files. If you exported TextBundle files, extract the Markdown and collect the bundled assets into `.attachments`. Octarine does not import `.textbundle` files directly. ### Compatibility Notes Markdown text, headings, lists, and checklists should move cleanly. Agenda-specific project status, scheduled dates, calendar event links, people, notes-on-the-agenda state, and internal Agenda links do not transfer directly. After each batch, open a few notes in Octarine and check the links, dates, and attachments before exporting the next batch. #### Quick Answers ### Can I migrate Agenda notes to Octarine? Yes. Export or copy Agenda notes as Markdown in batches, then organize the exported files into an Octarine workspace. ### Does Octarine import Agenda TextBundle files directly? No. Extract the Markdown and assets from TextBundle exports before moving them into Octarine. ### Do Agenda projects and calendar links transfer to Octarine? Agenda-specific projects, scheduled dates, calendar event links, and internal app state do not transfer directly. Recreate what you need with folders, tags, properties, or daily notes. -------------------------------------------------------------------------------- title: "Logseq" description: "Use a Logseq graph as an Octarine workspace" source: "https://docs.octarine.app/importing/logseq" -------------------------------------------------------------------------------- # Logseq Logseq stores graphs as local files, usually Markdown or Org files. If your graph uses Markdown, you can open the graph folder directly in Octarine. If it uses Org mode, convert the important notes to Markdown before migrating. ### Direct Migration Find your Logseq graph folder. It usually contains folders such as: ```text journals/ pages/ assets/ logseq/ ``` Open Octarine and click the **Workspace Switcher** in the top-left corner. Select **Create Workspace**, give it a name, and toggle **Use an existing folder?**. Choose the root of your Logseq graph and press Create. ### Pages and Journals Logseq stores regular pages in `pages/` and journal notes in `journals/`. Octarine will show those folders in the file tree. If you want Logseq journals to behave like Octarine daily notes, create a `Daily` folder and move the journal files into it. Rename them to Octarine's daily note format if needed: ```text YYYY-MM-DD.md ``` Keep a backup of the original graph before moving files, especially if you still plan to open it in Logseq. ### Outliner Formatting Logseq is an outliner, so many pages are written as nested bullet blocks. Octarine can display the Markdown, but long notes may feel better if you remove unnecessary top-level bullets and turn major blocks into headings. For example: ```markdown - Project plan - Goals - Risks ``` can become: ```markdown # Project plan ## Goals ## Risks ``` ### Assets Logseq stores media files in `assets/`. Octarine's convention is `.attachments` at the workspace root. You can keep `assets/` if the existing Markdown links work, or rename it to `.attachments` and update references. If you still use the folder in Logseq, keep `assets/` and avoid changing paths. ### Compatibility Notes Logseq wikilinks and tags are close to Octarine's syntax, so many links will continue to work. Block references, block embeds, queries, TODO workflows, page properties, and Logseq plugin data are Logseq-specific and may need manual cleanup. Org mode files are not Octarine notes. Convert `.org` files to Markdown before expecting them to behave like regular notes in Octarine. #### Quick Answers ### Can Octarine open a Logseq graph? Yes, if the graph uses Markdown files. Create an Octarine workspace from the Logseq graph folder. ### Does Octarine support Logseq Org mode files? No. Convert `.org` files to Markdown before using them as Octarine notes. ### Do Logseq block references and queries transfer to Octarine? No. Logseq block references, embeds, queries, and plugin data are Logseq-specific and may need manual cleanup. -------------------------------------------------------------------------------- title: "NotePlan" description: "Use NotePlan Markdown files in Octarine" source: "https://docs.octarine.app/importing/noteplan" -------------------------------------------------------------------------------- # NotePlan NotePlan stores notes locally as plain text or Markdown files. If your notes already use the `.md` extension, you can create an Octarine workspace from the NotePlan folder. If they use `.txt`, copy or export the notes first and convert the files you want to use in Octarine to `.md`. ### Find Your NotePlan Notes In NotePlan, use the note menu or Finder option to show your notes folder. NotePlan's local data may include regular notes, calendar notes, and app metadata. Before migrating, make a copy of the NotePlan folder. This keeps the original safe and lets you reshape the copied folder for Octarine without affecting NotePlan. ### Create an Octarine Workspace If your copied notes are Markdown files, open Octarine and click the **Workspace Switcher** in the top-left corner. Select **Create Workspace**, give it a name, and toggle **Use an existing folder?**. Choose the copied NotePlan folder and press Create. If your files use `.txt`, rename the notes you want to migrate to `.md` first. Octarine treats Markdown files as notes. ### Calendar Notes NotePlan calendar notes often use compact filenames such as `YYYYMMDD.txt` or `YYYYMMDD.md`. Octarine daily notes use a `Daily` folder and the `YYYY-MM-DD.md` format. For daily notes, create a `Daily` folder and rename files like this: ```text 20260613.md -> Daily/2026-06-13.md ``` Weekly, monthly, and quarterly planning notes can stay as regular notes, or you can place them in folders that match your workflow. ### Links and Tasks NotePlan supports Markdown links, backlinks, hashtags, and task syntax. After migration, open a few heavily linked notes and confirm that links resolve correctly. For notes inside folders, Octarine wikilinks should include the path from the workspace root: ```markdown [[Projects/Launch Plan]] ``` ### Compatibility Notes Markdown formatting, checklists, tags, and most plain text content should transfer cleanly. NotePlan-specific scheduling, repeat rules, calendar integration, filters, perspectives, plugin data, and app settings do not become Octarine settings. If you still want to use the same files in NotePlan and Octarine, change paths carefully and test on a small folder first. #### Quick Answers ### Can I use NotePlan notes in Octarine? Yes. If your NotePlan notes are Markdown files, create an Octarine workspace from a copied NotePlan folder. ### Do NotePlan .txt notes work as Octarine notes? Convert the notes you want to use in Octarine from `.txt` to `.md` first. ### How should I migrate NotePlan calendar notes? Put daily notes in a `Daily` folder and rename them to Octarine's `YYYY-MM-DD.md` daily note format. -------------------------------------------------------------------------------- title: "Troubleshooting" description: "Resources on how to raise bugs or feature requests" source: "https://docs.octarine.app/help/troubleshooting" -------------------------------------------------------------------------------- # Troubleshooting ### Questions and Advice Have a question about how Octarine works, or just want to connect with other users? The best place to start is the [Discord server](https://octarine.app/discord). It's a friendly community where you can ask questions, share tips, and learn from other people using Octarine. ### Requesting Features or Reporting Bugs Found a bug or have an idea for a new feature? I'd love to hear about it. Before submitting, take a quick look through the existing issues to make sure someone else hasn't already reported it—this helps keep things organized and avoids duplicates. To submit a bug report or feature request: - Head over to the [Feedback Tracker](https://github.com/rajatkulkarni95/octarine-feedback/issues) and create a new issue - Choose either `Bug` or `Feature Request` depending on what you're submitting - Include as much detail as possible—screenshots, steps to reproduce, context about what you were trying to do—so we can get to the bottom of it faster You can also report bugs or suggest features on the Discord server if you prefer, though the GitHub tracker is the best place to make sure nothing gets lost. ### Email Support If you're a Pro License user, you have access to direct email support. Feel free to reach out for any questions or issues at [rajat@octarine.app](mailto:rajat@octarine.app). That said, if you're reporting a bug or requesting a feature, please use the Feedback Tracker or Discord instead—that way the whole community can benefit from the discussion and any solutions we come up with. #### Quick Answers ### Where can I report an Octarine bug? Report bugs on the Feedback Tracker, or use Discord if you prefer to discuss the issue with the community first. ### Where can I request an Octarine feature? Use the Feedback Tracker for feature requests so they can be tracked, discussed, and avoided as duplicates. ### How do Pro users contact Octarine support? Pro users can use the direct email support address shown in this guide. -------------------------------------------------------------------------------- title: "Refund Policy" description: "Information about refunds for Octarine Pro licenses" source: "https://docs.octarine.app/help/refunds" -------------------------------------------------------------------------------- # Refund Policy ### Refund Policy We want you to be completely satisfied with Octarine. If you've purchased a Pro license and it's not the right fit, we offer a straightforward refund policy. ### Eligibility You can request a full refund within **7 days** of your Pro license purchase, no questions asked. After this period, refunds are evaluated on a case-by-case basis. Additional device slots purchased as add-ons to an existing license are **final sale and non-refundable**. ### How to Request a Refund To request a refund: 1. Contact us at the support email address provided in your purchase confirmation 2. Include your order number or purchase email in your request 3. We'll process your refund within 6-10 business days **Important:** Once you request a refund, your Pro license will be immediately deactivated and you will lose access to all Octarine Pro features. This happens as soon as the refund process begins, not when the payment is returned. Refunds are issued to the original payment method used for the purchase. ### Questions? If you have any questions about our refund policy or need assistance, please reach out through: - Email support (for Pro license holders - check your purchase confirmation for the address) - Our [Discord community](https://octarine.app/discord) - The [Feedback Tracker](https://github.com/rajatkulkarni95/octarine-feedback/issues) We're here to help make sure you have a great experience with Octarine. #### Quick Answers ### Can I get a refund for Octarine Pro? Yes. You can request a full refund within 7 days of purchasing a Pro license. After that, refunds are evaluated case by case. ### Are extra device slots refundable? No. Additional device slots purchased as add-ons are final sale and non-refundable. ### What happens to my Pro license after a refund request? Your Pro license is immediately deactivated when the refund process begins, so you lose access to Pro features before the payment is returned. -------------------------------------------------------------------------------- title: "Meet the companion" description: "Set up Octarine on your iPhone and activate your license" source: "https://docs.octarine.app/iOS/getting-started" -------------------------------------------------------------------------------- # Meet the companion Octarine is a local-first, privacy-focused note-taking app built around Markdown. Your notes are plain `.md` files stored on your device — you own them completely. Octarine layers a rich editing experience, daily journaling, tagging, linking, and powerful search on top of that simple foundation. This guide walks you through your first few minutes in the app. ## Activating Your License When you first open Octarine, you'll see a short carousel showcasing the app's key features — Notes, Daily Desk, Editor, Command Bar, Search, Properties, and Themes. Swipe through or tap the dots to browse, then tap **Get Started**. On the sign-in screen, enter: - **Email** — the address you used when you purchased Octarine. - **License key** — the key from your purchase confirmation email. Tap the paste button next to the field to paste it from your clipboard. Tap **Sign In**. The app validates your license with the Octarine server. Once confirmed, you're in. Each activation counts towards your license's **3 device limit** (across all platforms — macOS, iOS, etc.). If you hit the activation limit, deactivate one of your existing devices from within the app, or manage your activations via the [Octarine Dashboard](https://octarine.app/dashboard) or the [LemonSqueezy dashboard](https://app.lemonsqueezy.com/my-orders) (linked in your purchase receipt). If you need more than 3 devices, you can purchase additional seats from the [Octarine Dashboard](https://octarine.app/dashboard) to expand your license. > You may hit the activation limit even if you only have one device in hand. Upgrading, wiping, or reinstalling doesn't auto-deactivate the previous install — each reactivation counts as a fresh one. Open the [Octarine Dashboard](https://octarine.app/dashboard) or [LemonSqueezy dashboard](https://app.lemonsqueezy.com/my-orders) to review every activation tied to your license and remove any stale ones. Your license is re-validated periodically in the background. If you're offline, the app continues to work normally — validation is deferred until you're back online. Let’s now head over to create your first workspace. #### Quick Answers ### How do I activate Octarine on iPhone? Enter the email and license key from your Octarine purchase confirmation, then tap **Sign In**. ### Does iOS activation count toward my device limit? Yes. Each iOS activation counts toward the 3-device limit across platforms. ### Can Octarine for iOS work while offline? Yes. The app continues to work offline, and license validation is deferred until you are back online. -------------------------------------------------------------------------------- title: "Workspaces" description: "Create, switch, and manage your note workspaces" source: "https://docs.octarine.app/iOS/workspaces" -------------------------------------------------------------------------------- # Workspaces A workspace is Octarine's top-level container. Each workspace is an independent folder on disk containing your notes, daily entries, and attachments. You can have multiple workspaces — for example, one for personal notes and another for work. ## Creating a New Workspace You can create a workspace during onboarding or later from the Command Bar (pull down and search for "Switch Workspace") or from **Settings > Switch**. When creating a workspace you choose: - **Name** — displayed in the settings header and workspace chooser. The first letters form the avatar. - **Color** — a background and border color for the avatar. - **Storage location**: - **On my iPhone** — local device storage. - **iCloud Drive** — synced via iCloud across your Apple devices. - **Dropbox** — synced via your Dropbox folder. Three starter notes (Welcome, today's daily note, and a weekly note) are generated automatically in every new workspace. ## Dropbox > We've since found that Dropbox doesn't always handle **dot folders** (for example `.octarine`, `.attachments`, and similar) correctly. In some cases those folders can be renamed to something like `Unknown File.octarine`, which can break parts of the app - most notably Inbox/Quick Capture. A fix is being worked on but may take a little time. The first time you create a Dropbox workspace, iOS opens the Files picker so Octarine can be granted access to your Dropbox folder. This is a one-time step. When the picker appears: 1. Tap **Browse** at the bottom, then tap **Dropbox** in the sidebar. 2. Stay at the **root of your Dropbox** — don't enter any subfolder. 3. Tap **Open** in the top-right corner. Octarine creates an `Octarine` folder at the root of your Dropbox and stores all workspaces inside it. Every new Dropbox workspace from here on lands in the same place automatically — you won't see the picker again. Picking the root also matches where the desktop app looks, so workspaces stay in sync across devices. ## Switching Between Workspaces There are three ways to switch: 1. **Home** — tap the workspace pill (avatar + name) at the top of the Home screen to open the workspace switcher sheet directly, without leaving the page. 2. **Command Bar** — pull down from the top of any screen, type "Switch Workspace", and select from the submenu listing your other workspaces. 3. **Settings** — go to Settings and tap **Switch** next to the workspace name at the top. The Command Bar and Settings options take you to the workspace chooser, where you can pick an existing workspace or create a new one. ## Workspace Discovery When you open the workspace chooser, Octarine scans the app-created `Octarine` folder in on-device storage, iCloud Drive, and Dropbox for workspace directories it hasn't seen before. Discovered workspaces appear in the list alongside your existing ones, showing the storage location (phone, iCloud, or Dropbox) with an icon on the right side. The `Octarine` folder itself must be created by the app — creating a folder named `Octarine` yourself (in Files, Finder, or Dropbox) will not work. The app sets up this folder the first time you choose a storage location during workspace creation, and from then on it is the only folder Octarine looks in for existing workspaces. Any workspace folders placed outside of it won't be discovered. If no workspaces are found, the screen shows a message and a button to create one. > All workspaces MUST live inside the app-created `Octarine` folder in on-device storage, iCloud Drive, or Dropbox — and that folder itself can only be created by the app, not manually. Octarine can’t access folders outside of these locations. When you uninstall the app, iOS automatically deletes the `Octarine` folder from on-device storage, so please keep a backup so you don’t lose your notes. This is not the case with the cloud solutions. ## But what about my existing notes?? By operating under the rules of the Apple ecosystem, Octarine can't access your entire system — only the `Octarine` folder it's entitled to by the OS. Desktop OSes don't have this restriction, so if you already have a workspace synced via the desktop app in a custom location, here's how to bring it over to iOS. **The `Octarine` folder in iCloud must be created by the iOS app** when you create an iCloud workspace. Creating a folder named `Octarine` yourself in Files or Finder does not give Octarine the access it needs — only the in-app flow sets up iCloud correctly. 1. **Create an iCloud workspace** from the iOS app (onboarding or **Switch Workspace**), choosing **iCloud Drive**. That step is what creates the app-managed `Octarine` folder in iCloud with the right permissions. 2. **Copy your existing workspace folder** from the desktop location into that new `Octarine` folder in iCloud (for example in Files on Mac or iCloud.com). Prefer **copying** over moving for safety. If you **move** the data out of the original folder, the desktop app will no longer see that workspace at the old path — that is expected. You are not losing the copy in iCloud; you will reconnect the desktop app to the workspace in its new iCloud location in the next step. 3. The app discovers the workspace automatically once it sits inside the app-created `Octarine` folder. On iOS, open **Manage Workspaces** — the copied workspace appears there alongside any workspace the app created during setup. 4. On **desktop**, use **Create Workspace > Open Existing** and choose the same workspace folder inside `Octarine` in iCloud Drive. That reconnects the desktop app to the synced copy (the old custom path will not work anymore if you moved the data out of it). The first iCloud workspace you created on iOS may have been a small "dummy" setup used mainly to establish the folder. After your real notes are in place, you can **delete that workspace** from settings if you do not need it, or **leave it** — either is fine. ## Deleting a Workspace Go to **Settings > Delete Workspace** at the bottom of the settings page (under "Danger Zone"). This permanently removes the workspace from Octarine. This deletes all notes and folders and the workspace folder from the device/iCloud/Dropbox. > This is a destructive action. Please make sure you understand the consequences You'll see a confirmation screen with the workspace name and a warning before the delete button becomes active. #### Quick Answers ### Where can Octarine for iOS store workspaces? iOS workspaces can live in app-managed Octarine folders on your iPhone, in iCloud Drive, or in Dropbox. ### Can I bring an existing desktop workspace to iOS? Yes. Create an iCloud workspace from the iOS app first, then copy your existing workspace into the app-created `Octarine` folder in iCloud. ### Why can't I manually create the Octarine folder for iOS? iOS only grants the app access to folders it creates through the in-app flow, so the `Octarine` folder must be created by the app. -------------------------------------------------------------------------------- title: "Navigating the App" description: "Move between screens using the bottom nav bar and More menu" source: "https://docs.octarine.app/iOS/navigating-the-app" -------------------------------------------------------------------------------- # Navigating the App Octarine uses a bottom navigation bar as the main way to move between screens. The app is locked to portrait orientation. ## Bottom Navigation Bar The nav bar is a rounded pill at the bottom of the screen that holds a few primary destinations, a **More** button (···), and a floating **+** button to its right. Only the **first three** items in your nav order are shown as visible tabs. The rest live inside the More menu. You can reorder and hide items — see [Customizing the Nav](https://docs.octarine.app/iOS/navigating-the-app#customizing-the-nav) below. The active tab is highlighted with a filled icon. The nav bar hides automatically when you're inside the editor to give you full-screen writing space. ## The More Menu Tap the **More** button (···) to expand a menu listing every nav destination (visible tabs included). The full set of items: | Item | What it opens | | --- | --- | | **Home** | The dashboard with the week calendar, pinned notes, recent notes, unfinished tasks, and a random note | | **Notes** | The file tree browser | | **Daily** | The Daily Desk calendar | | **Search** | The full-text search overlay | | **Pinned** | Your pinned notes list | | **Tags** | The tag hierarchy browser | | **Properties** | The frontmatter properties browser | | **Templates** | The templates list | | **Attachments** | The media grid (images and videos) | | **Settings** | Preferences, editor config, themes, and account | The menu header shows the current workspace name and a slider icon that opens the **Customize** screen. Tap outside the menu or select an item to close it. When a More-menu page is active, the ··· icon in the nav bar changes to show the icon of the current page. ## The + Button A floating **+** button sits to the right of the nav pill. If you have no templates, tapping it creates a blank note immediately. If you have templates, it opens a sheet with two options: - **Blank Note** — creates an untitled note. - **From Template** — opens a submenu of your templates; tap one to create a new note from it. If you're inside a folder in the Notes page, the new note is created in that folder. ## Customizing the Nav Tap the slider icon in the More menu header to open **Customize**. Here you can: - **Reorder** items by dragging the handle on the right. The first three items in the order become the visible tabs. - **Show or hide** items with the toggle. Hidden items move to a separate "Hidden" section at the bottom. At least three items must remain visible. Changes save automatically when you close the screen. ## Gestures - **Swipe back** — swipe from the left edge to go back from the editor, the Notes folder view, or any detail screen. - **Pull down** — pull down from the top of any screen to open the Command Bar (covered in the next section). ## Portrait Only Octarine is locked to portrait orientation. Rotating your device has no effect on the layout. -------------------------------------------------------------------------------- title: "Home" description: "Your dashboard with a week view, pinned notes, recent activity, unfinished tasks, and a random note" source: "https://docs.octarine.app/iOS/home" -------------------------------------------------------------------------------- # Home Home is your dashboard — a single screen that surfaces what matters most so you can jump straight into your notes. ## Header The top of Home shows your workspace avatar and name as a pill, with a gear icon next to it. - Tap the **workspace pill** to open the workspace switcher sheet — pick a different workspace or create a new one without leaving Home. - Tap the **gear** to jump to Settings. A time-based greeting ("Good morning", "Good afternoon", "Good evening") sits directly below the header. ## Pinned Notes A compact list of notes you've pinned. Tap any to open it in the editor. Pinning is covered in detail in the [Pinned Notes](https://docs.octarine.app/iOS/pinned-notes) section. ## Recently Viewed Shows notes you've opened recently, ordered by last access time. A quick way to return to whatever you were working on. ## This Week A seven-day row for the current week. Each day cell shows the date; today is highlighted, and a small accent dot under a date means a daily note already exists for it. Tap any day to open or create its daily note. The week number (e.g., `W16`) is shown on the right and is tappable — it opens or creates the weekly note. The week start day follows the **Week Starts On** setting in Settings → Date & Time. ## Unfinished This section only appears if you have notes containing incomplete tasks (unchecked checkboxes). It shows up to three notes, sorted by the number of pending tasks (highest first), then by last modified date. Each entry shows the note name and a task count breakdown. Tap to open the note. A **Browse Notes** link in the header takes you to the full Notes page. ## Random Note Displays a single randomly selected note from your workspace. Tap **Shuffle** in the section header to pick a different one. Tap the note to open it. If your workspace has no notes yet, a message prompts you to create some first. -------------------------------------------------------------------------------- title: "Command Bar" description: "Quick-access palette for jumping to notes, running actions, and navigating the app" source: "https://docs.octarine.app/iOS/command-bar" -------------------------------------------------------------------------------- # Command Bar The Command Bar is a quick-access palette for jumping to notes, running actions, and navigating the app — all from one place. ## Opening the Command Bar Pull down from the top of any screen. As you pull, a pill labeled **"Search for anything"** appears and follows your finger. Once you've pulled far enough (you'll feel a haptic tap), release to open the Command Bar. The gesture won't trigger if you're scrolled down in a list, or if you're actively typing inside the editor with a text selection. ## Searching The Command Bar opens with a text field — **"Search notes, actions..."**. Start typing to filter results instantly. It searches across three categories simultaneously: - **Notes** — fuzzy-matches against your note names. When the bar is empty, it shows your recently viewed files. - **Dates** — understands natural language like "tomorrow", "next friday", "jan 2024", or "3 days ago". Matched dates appear at the top as a quick way to open or create that day's daily note. - **Actions** — fuzzy-matches against all available commands (see below). ## Available Actions Actions are grouped into sections. Some are always available; others only appear in certain contexts. ### Notes These actions only appear when you have a note open in the editor: | Action | What it does | | --- | --- | | **Delete Note** | Deletes the current note | | **Duplicate Note** | Creates a copy of the current note | | **Pin Note** | Pins the note (hidden if already pinned) | | **Unpin Note** | Unpins the note (hidden if not pinned) | | **Make note read-only** | Locks the note from editing | | **Make note editable** | Unlocks a read-only note | | **Copy Content** | Copies the note's markdown to clipboard | | **Move to Folder** | Opens a submenu of folders to move the note into | ### Create | Action | What it does | | --- | --- | | **New Note** | Creates a new note | | **New Note in This Folder** | Creates a note in the current folder (only visible when inside a subfolder) | | **New Folder** | Creates a new folder | ### Navigation | Action | What it does | | --- | --- | | **Go to Home** | Opens the Home dashboard | | **Go to Daily** | Opens the Daily Desk | | **Go to Notes** | Opens the file tree | | **Search in Notes** | Opens the Search overlay | | **Go to Tags** | Opens the Tags browser | | **Go to Properties** | Opens the Properties browser | | **Go to Templates** | Opens the Templates list | | **Go to Attachments** | Opens the Attachments grid | | **Go to Settings** | Opens Settings | ### Workspace | Action | What it does | | --- | --- | | **Switch Workspace** | Opens a submenu listing your other workspaces | This action only appears if you have more than one workspace. ### App | Action | What it does | | --- | --- | | **Send Feedback** | Opens a feedback link | | **Report Bug** | Opens a bug report link | | **About** | Navigates to the About page | ## Submenus Some actions (like **Move to Folder** and **Switch Workspace**) open a submenu. A back arrow appears at the top of the submenu to return to the main list. -------------------------------------------------------------------------------- title: "Editor" description: "Write and format your notes with a rich Markdown editor and toolbar" source: "https://docs.octarine.app/iOS/editor" -------------------------------------------------------------------------------- # Editor The editor is where you write. It's a rich Markdown editor that renders formatting as you type, auto-saves your changes, and gives you quick access to every block type from a single toolbar. ## Opening a Note Tap any note from the Notes page, Home, Daily Desk, Search results, or any other list. The editor opens full-screen — the bottom navigation bar hides to give you the full screen for writing. Swipe from the left edge to go back. ## The Editor Header A thin header sits above the note. It has a back button on the left and a row of circular buttons on the right: | Button | What it does | |--------|--------------| | **Tasks pill** | Shows the incomplete/complete task count for the note. Tap to see a detailed breakdown. | | **Lock** (closed lock) | Only appears when the note is locked. Tap to unlock and make it editable again. | | **Info** (i) | Opens the Note Info panel (Stats, Outline, Backlinks). | | **Options** (slider icon) | Opens the actions sheet — pin, lock, rename, duplicate, move, delete, copy, and more. | Daily and weekly notes only show Info and Options after the file has been created. ## The Toolbar When the keyboard is active, a toolbar appears directly above it. It scrolls horizontally. From left to right: | Button | What it does | |--------|--------------| | **Undo / Redo** | Step backward or forward through your edits | | **Clear Formatting** | Remove all marks and block styling from the selection | | **Dictation** | Start voice-to-text input (only shown if dictation is enabled and the model is downloaded) | | **+** (Block Picker) | Open the block picker panel to insert any block type | | **[[** | Insert a wikilink and open the suggestion popover | | **B** | Bold | | **I** | Italic | | **\`** | Inline code | | **Highlight** | Apply a colored background to text | | **Text color** | Apply a color to text | | **Bullet list** | Start or toggle a bullet list | | **To-do list** | Start or toggle a checkbox list | | **Image** | Insert an image | When your cursor is inside a list, **indent** and **outdent** buttons also appear. A **Hide Keyboard** button sits at the far right, pinned outside the scrollable row. Active formatting (e.g., bold is on at the cursor) is shown with a highlighted button state. Long-press any toolbar button to see its name as a toast. ## Block Picker Tap the **+** button in the toolbar to open the block picker panel, which slides up from the bottom. It's organized into sections: **Blocks** — Text, Heading 1 through Heading 6, Bullet List, Numbered List, To-do List, Code Block, Blockquote, Inline Code, Divider, Table, Mermaid, Math Block. **Insert** — Wiki Link, Image, File attachment, Today's Daily, Tomorrow's Daily, Yesterday's Daily. **Templates** — if your workspace has templates, each one appears as a button. Tapping inserts the template's content at the cursor and merges its frontmatter into the current note. **Highlight** — Remove highlight, plus Red, Orange, Yellow, Green, Blue, Purple color options. **Colored Text** — the same seven color options applied to text instead of background. **Callouts** — Info, Tip, Warning, Error, Success. **Date & Time** — Today's Date, Tomorrow, Yesterday, Current Time, Date & Time. Tap any item to insert it at your cursor position. ## Options Sheet Tap the slider icon in the editor header to open the options sheet: | Action | What it does | |--------|--------------| | **Properties** / **Add Property** | Open the properties sheet for this note | | **Pin** / **Unpin** | Toggle the note's pinned state (not shown for templates) | | **Make note read-only** / **Make note editable** | Toggle the `locked` frontmatter | | **Copy Content** | Copy just the note's markdown body | | **Copy with Properties** | Copy the markdown body together with its YAML frontmatter | | **Rename** | Rename the note via an inline field | | **Duplicate** | Create a copy of the note | | **Move to Folder** | Move the note to the workspace root or another folder (not shown for daily/weekly notes or templates) | | **Delete** | Delete the note after confirmation | ## Text Formatting Standard Markdown formatting is available through the toolbar or by typing the syntax directly: | Format | Toolbar | Markdown syntax | |--------|---------|-----------------| | **Bold** | B button | `**text**` | | *Italic* | I button | `*text*` | | ~~Strikethrough~~ | Block picker | `~~text~~` | | Underline | Block picker | `~text~` | | `Inline code` | \` button | `` `text` `` | ## Headings Six heading levels are available. Use the block picker or type `#` through `######` followed by a space at the start of a line. ## Lists - **Bullet list** — tap the bullet list button or type `- ` at the start of a line. - **Numbered list** — use the block picker or type `1. ` at the start of a line. - **To-do list** — tap the checkbox button or type `- [ ] ` at the start of a line. Tap a checkbox to toggle it between complete and incomplete. When inside a list, use the indent/outdent buttons to nest items. ## Callouts Callouts are highlighted blocks for drawing attention to specific information. Five types are available from the block picker: | Type | Use for | |------|---------| | **Info** | General information | | **Tip** | Helpful suggestions | | **Warning** | Caution or important caveats | | **Error** | Problems or critical issues | | **Success** | Confirmations or positive outcomes | In Markdown, callouts use the blockquote syntax with a type marker: ``` > [!TIP] > Your callout text here. ``` ## Code Blocks Insert a code block from the block picker or type triple backticks (` ``` `) on a new line. Syntax highlighting is applied automatically based on the language. Many languages are supported including JavaScript, TypeScript, Python, Rust, Go, Swift, HTML, CSS, SQL, and more. ## Tables Insert a table from the block picker. Tables use standard Markdown pipe syntax: ``` | Header 1 | Header 2 | |----------|----------| | Cell 1 | Cell 2 | ``` ## Math Octarine supports LaTeX math rendering via KaTeX. - **Inline math** — wrap an expression in single dollar signs: `$E = mc^2$` - **Block math** — insert a Math Block from the block picker, or use double dollar signs on their own lines: ``` $$ x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$ ``` ## Mermaid Diagrams Insert a Mermaid block from the block picker to create diagrams using the Mermaid syntax. Supported diagram types include flowcharts, sequence diagrams, Gantt charts, and more. ## Images and Files Tap the image button in the toolbar — or the Image / File item in the block picker — to attach media. Images go into `.attachments/`; other files (PDF, plain text, Word, Excel, HTML, JSON, CSV) go into `.files/`. Reference them with wikilinks: ``` [[photo.png]] [[photo.png|500]] [[report.pdf]] ``` The number after the pipe sets the width in pixels for images. ## Dictation If dictation is enabled, the microphone button appears in the toolbar. Tap it to start recording; tap the red **Stop** button to finish. If the model hasn't been downloaded yet, a sheet appears prompting you to download it from **Settings → Dictation**. ## Frontmatter Notes can include YAML frontmatter at the very top of the file, between `---` delimiters: ```yaml --- title: My Note status: draft pinned: true tags: - project - planning --- ``` Frontmatter properties are displayed as a strip below the editor header when present. Tap the strip to open the properties sheet, where you can view, add, edit, and delete properties. Supported property types: Text, Number, Date, Date & Time, Checkbox, List, Tags, and Files. ## Note Info Panel Tap the info (i) button in the editor header to open the Note Info panel. It has three tabs: - **Stats** — created date, updated date, word count, character count, line count, reading time, and a list of linked notes (notes this one links to). - **Outline** — a clickable table of contents generated from your headings. Tap a heading to scroll to it. - **Backlinks** — notes that reference the current note via wikilinks, with a short preview of the surrounding context. ## Auto-Save Changes are saved automatically as you type. There's no save button — just write and navigate away when you're done. -------------------------------------------------------------------------------- title: "Wikilinks & Tags" description: "Connect your notes with links and organize them with tags" source: "https://docs.octarine.app/iOS/wikilinks-and-tags" -------------------------------------------------------------------------------- # Wikilinks & Tags Wikilinks and tags are how you connect your notes. Wikilinks create direct links between notes. Tags let you categorize and filter across your entire workspace. ## Wikilinks A wikilink is a reference to another note, written in double brackets: ``` [[Note Name]] ``` Tap a wikilink in the editor to jump to that note. If the linked note doesn't exist yet, tapping it creates it. ### Linking to Notes in Subfolders If a note lives inside a folder, include the path relative to the workspace root: ``` [[Projects/Design Doc]] [[Work/Meetings/Standup Notes]] ``` The `.md` extension is optional — Octarine adds it automatically. ### The Suggestion Popover Tap the **[[** button in the toolbar (or type `[[` manually) to trigger the suggestion popover. As you type inside the brackets, the popover filters your notes in real time using fuzzy matching. Tap a suggestion to complete the link. ## Tags A tag is any word prefixed with `#` in the body of a note: ``` Working on the new dashboard. #project #frontend ``` Tags are extracted and indexed automatically. They support letters, numbers, underscores, hyphens, and Unicode characters. ### Nested Tags Use `/` to create a tag hierarchy: ``` #work/engineering/backend #priority/high ``` Nested tags let you organize categories at multiple levels. A note tagged `#work/engineering` will also appear under the parent `#work` when browsing. ### Tag Suggestions When you type `#` in the editor, a suggestion popover appears with existing tags from your workspace. This makes it easy to reuse tags consistently without remembering the exact spelling. ## Browsing Tags Open the **Tags** page from the More menu. It displays all tags in your workspace as a hierarchical tree. - **Search** — filter tags by typing in the search field at the top. - **Expand/collapse** — tap a parent tag to show or hide its children. - **View notes** — tap any tag to see a list of every note that uses it. If no tags exist yet, the page shows a "No tags found" message. ## Backlinks When note A links to note B via a wikilink, note B records that as a backlink. You can see a note's backlinks in the **Backlinks** tab of the Note Info panel (swipe from the right edge of the editor). Backlinks let you discover connections you might not remember — which notes reference the one you're reading. -------------------------------------------------------------------------------- title: "Attachments" description: "Manage images and videos stored in your workspace" source: "https://docs.octarine.app/iOS/attachments" -------------------------------------------------------------------------------- # Attachments Attachments are images and videos stored in your workspace. They live in the `.attachments/` folder and can be referenced from any note. ## The Attachments Page Open **Attachments** from the More menu. Your media files are displayed in a 3-column grid of thumbnails. Videos show a play button overlay on their thumbnail. Use the search field at the top to filter attachments by filename. ## Previewing Tap any thumbnail to open it in a full-screen lightbox. Images are displayed at full resolution. Videos play with playback controls. Tap the close button or tap outside the media to exit the lightbox. ## Context Menu Long-press an attachment to open a context menu with two options: - **Copy Wikilink** — copies the wikilink reference (e.g., `[[photo.png]]`) to your clipboard so you can paste it into a note. - **Delete Attachment** — permanently removes the file from your workspace. ## Referencing Attachments in Notes To display an attachment inside a note, use the wikilink syntax: ``` [[photo.png]] ``` For external images (not stored in your workspace), use standard Markdown syntax: ``` ![Alt text](https://example.com/image.png) ``` ## Supported Formats **Images:** PNG, JPG, JPEG, GIF, SVG, WebP **Videos:** MP4, WebM, MOV -------------------------------------------------------------------------------- title: "Notes" description: "Browse, create, sort, and manage your notes and folders" source: "https://docs.octarine.app/iOS/notes" -------------------------------------------------------------------------------- # Notes The Notes page is a file tree browser that shows every note and folder in your workspace. Open it from the bottom navigation bar. ## Browsing the File Tree Notes and folders are displayed in a hierarchical tree. Tap a folder to open it as its own page; tap a note to open it in the editor. Folder pages show the folder name as the title, with the parent path as a breadcrumb subtitle. Tap the back button or swipe from the left edge to return to the parent folder. ## Creating Notes and Folders - **New note** — tap the floating **+** button in the bottom-right corner of the screen. This creates a new untitled note (or opens the Blank/Template sheet if you have templates). - **New note in a folder** — open the folder and use the **+** button, or long-press a folder from its parent to see folder actions. - **New folder** — tap the ··· (options) button in the folder's header and choose **New Folder**. A dialog appears where you enter the folder name, then tap **Save**. ## File Context Menu Long-press a note in the tree to open its context menu: | Action | What it does | |--------|--------------| | **Pin** / **Unpin** | Toggle the note's pinned state | | **Rename** | Rename the note | | **Duplicate** | Create a copy of the note | | **Move to Folder** | Move to the workspace root or another folder | | **Delete** | Delete the note after confirmation | ## Folder Context Menu Long-press a folder to open its context menu: | Action | What it does | |--------|--------------| | **Change Icon** | Pick a custom icon for this folder | | **New Note** | Create a new note inside the folder | | **New Folder** | Create a subfolder | | **Rename** | Rename the folder | | **Move to Folder** | Move this folder inside another | | **Delete** | Delete the folder and everything in it, after confirmation | ## Folder Icons Folders can have custom icons. Pick one from **Change Icon** in the folder's context menu — the selected icon replaces the default folder glyph in the tree. ## Sorting Tap the sort button (down arrow) in the header to open the sort sheet. Six options are available: | Sort | Direction | | --- | --- | | **Name** | A to Z | | **Name** | Z to A | | **Created** | Newest first | | **Created** | Oldest first | | **Modified** | Newest first | | **Modified** | Oldest first | The active sort option shows a checkmark. The sort applies to both files and folders within the tree. ## Searching The search field at the top of the page filters the tree as you type. Fuzzy matching is used — you don't need to type the exact name. Folders containing matching notes auto-expand to show the results. ## Collapsing All Tap the collapse button in the header to collapse every folder in the tree at once. Useful when the tree gets deeply expanded and you want a clean starting view. -------------------------------------------------------------------------------- title: "Pinned Notes" description: "Pin your most important notes for quick access" source: "https://docs.octarine.app/iOS/pinned-notes" -------------------------------------------------------------------------------- # Pinned Notes Pinned notes are the notes you want quick access to. They appear in a dedicated page and on the Home dashboard. ## Pinning a Note There are two ways to pin a note: 1. **Command Bar** — open a note in the editor, pull down to open the Command Bar, and select **Pin Note**. 2. **Frontmatter** — add `pinned: true` to the note's YAML frontmatter: ```yaml --- pinned: true --- ``` To unpin, use the Command Bar's **Unpin Note** action, or change the frontmatter to `pinned: false`. ## The Pinned Page Open **Pinned** from the More menu. All your pinned notes are listed here. Tap any note to open it in the editor. A search field at the top lets you fuzzy-filter the list when you have many pinned notes. If no notes are pinned yet, the page shows a pin icon with the message "No pinned notes yet" and a hint to pin notes from the editor. ## Pinned on Home The Home dashboard also has a Pinned Notes section near the top, giving you a glanceable list without leaving the main screen. -------------------------------------------------------------------------------- title: "Search" description: "Find anything across your workspace with full-text search, filters, and sorting" source: "https://docs.octarine.app/iOS/search" -------------------------------------------------------------------------------- # Search Search lets you find anything across your entire workspace — note names, content, or both. ## Opening Search Tap the **magnifying glass** in the bottom navigation bar. A full-screen search overlay appears with a text field and your recent activity. ## Searching Start typing to search across all notes in the workspace. Results update in real time as you type, showing matched notes with highlighted excerpts. ## Filters Tap the slider icon in the search field to open the **Search options** sheet. A small dot on the icon indicates that at least one non-default filter is active. | Filter | What it does | |--------|--------------| | **Match case** | Matches exact letter casing (e.g., "API" won't match "api") | | **Whole word** | Only matches complete words, not partial matches inside longer words | | **Regex** | Treats the query as a regular expression for advanced pattern matching | | **Title only** | Restricts matching to note titles, ignoring body content | All four are off by default. They combine — for example, you can enable case-sensitive and whole word together. ## Sorting The same sheet has a **Sort by** row. Tap it to pick how results are ordered: - Last edited — newest first *(default)* - Last edited — oldest first - Created — newest first - Created — oldest first ## Recently Searched When you open Search with an empty field, your recent search queries are shown as chips at the top. Tap one to re-run that search instantly, or tap **Clear** to wipe the list. ## Recently Viewed Below recent searches, your recently viewed notes appear ordered by last access time. This gives you a quick way to return to notes you were just working on, even without searching. ## Persisted State Your search query and filters are remembered while you navigate away and back — returning to Search picks up where you left off. #### Quick Answers ### How do I search notes on Octarine for iOS? Tap the magnifying glass in the bottom navigation bar to open Search. ### Does iOS search support filters? Yes. You can filter by match case, whole word, regex, and title-only search. ### Does Octarine for iOS remember recent searches? Yes. Recent search queries appear as chips when you open Search with an empty field. -------------------------------------------------------------------------------- title: "Templates" description: "Reusable note scaffolds for recurring formats like meeting notes, journals, and checklists" source: "https://docs.octarine.app/iOS/templates" -------------------------------------------------------------------------------- # Templates Templates are regular notes stored in the workspace's `.templates/` folder. Anything you can write in a normal note — frontmatter, headings, checklists, wikilinks, tags — works in a template. When you create a note from a template, its content is copied into the new note and its frontmatter is merged in. ## The Templates Page Open **Templates** from the More menu (or via the Command Bar's **Go to Templates** action). The page lists all templates in your workspace, sorted alphabetically, with a search field at the top to fuzzy-filter by name. Tap a template to open and edit it like any other note. Tap the **+** button in the header to create a new blank template. ## Creating a Note From a Template There are two entry points: - **The + button in the bottom nav** — when at least one template exists, tapping **+** opens a sheet with **Blank Note** and **From Template**. Choosing **From Template** shows the list of templates; tap one to create a new note from it. - **The block picker inside a note** — tap **+** in the editor toolbar to open the block picker and scroll to the **Templates** section. Tapping a template inserts its content at the cursor and merges its frontmatter into the current note (existing values win over template defaults). ## Template Variables Templates support variables that are resolved when the template is applied. Variables use double curly braces: | Variable | Resolves to | Default format | |----------|-------------|----------------| | `{{title}}` | The new note's title (filename without `.md`) | — | | `{{date}}` | Current date | `yyyy-MM-dd` | | `{{date:FORMAT}}` | Current date with a custom format | User-specified | | `{{time}}` | Current time | `HH:mm` | | `{{time:FORMAT}}` | Current time with a custom format | User-specified | Format strings use [date-fns](https://date-fns.org/) tokens — for example, `{{date:MMMM d, yyyy}}` produces "April 22, 2026". Unknown variables are left untouched in the output. ## Example Template ```markdown --- type: meeting status: open tags: - meeting --- # {{title}} **Date:** {{date:EEEE, MMMM d}} **Time:** {{time}} ## Attendees - ## Agenda - ## Notes ## Action Items - [ ] ``` Saving this as `.templates/Meeting.md` gives you a one-tap meeting-note starter from the + button. -------------------------------------------------------------------------------- title: "Daily Desk" description: "Calendar-based interface for daily journaling and weekly planning" source: "https://docs.octarine.app/iOS/daily-desk" -------------------------------------------------------------------------------- # Daily Desk The Daily Desk is a calendar-based interface for daily journaling and weekly planning. Each day maps to a single Markdown file, and each week can have its own note too. ## The Calendar Open the Daily Desk from the bottom navigation bar. You'll see a vertically scrollable calendar organized by month. It spans from 2015 to 2035. Each day is a tappable cell. Tap a date to open its daily note — if one doesn't exist yet, it's created automatically. ### Indicators - **Dot** — a small accent-colored dot below a date means a note already exists for that day. - **Highlighted cell** — today's date has a distinct background so you can always spot it. ### Week Numbers The left column shows week numbers (labeled "WN" in the header). Tap a week number to open or create that week's note. ## Daily Notes Daily notes are stored as: ``` Daily/2026-04-15.md ``` The filename is always `YYYY-MM-DD`. When you tap a date, Octarine opens the note at that path — creating it if needed. ## Weekly Notes Weekly notes are stored as: ``` Daily/Weekly/2026-W16.md ``` The filename uses the ISO week number format `YYYY-W##`. Tap a week number in the calendar's left column to open it. ## Navigation - **Year selector** — a dropdown in the header lets you jump to a specific year. - **Today button** — the circular button in the header scrolls the calendar back to the current month and highlights today. ## Searching by Date The search field at the top of the Daily Desk accepts natural language. You can type things like: - `today` - `yesterday` - `tomorrow` - `3 days ago` - `next friday` - `jan 2024` The calendar scrolls to the matched date. This same natural language parsing works in the Command Bar — type a date phrase there to jump straight to a daily note from anywhere. -------------------------------------------------------------------------------- title: "Inbox & Quick Capture" description: "A capture queue you can offload thoughts into now and triage when you're ready" source: "https://docs.octarine.app/iOS/inbox" -------------------------------------------------------------------------------- # Inbox & Quick Capture Inbox is a separate, fast lane for getting things out of your head. Quick Capture pops a sheet from anywhere in the app — write, paste, or attach an image — and the result lands in a triage queue you can sort through whenever you have a moment. Captures live as plain Markdown files in `.octarine/inbox/` inside your workspace, so nothing leaves your device. ## Quick Capture Quick Capture is the fastest path from "I should write this down" to "it's saved." It's available from anywhere inside a workspace. ### Opening it Tap the **scribble** icon in the right-hand action pill of the bottom navigation bar. The sheet slides up over the keyboard and the editor is focused immediately, so you can start typing without a second tap. ### The capture sheet The sheet anchors to the top of the keyboard so your hands never leave the bottom of the screen. - **Editor** — a compact rich-text editor. The same wikilink, tag, task, and formatting syntax from the main editor works here. - **Title** — Tap the timestamp to write a custom title for the capture. - **Toolbar**: - **Image** — opens the photo picker. The selected image is copied into `.attachments/` and inserted as a figure. - **Checklist** — toggles a task list at the cursor. - **Paste** — pulls the clipboard contents into the editor. - **Priority chip** — set Urgent, High, Medium, Low, or None. Higher priorities triage first. - **Tag chip** — pick one tag from your configured Capture Tags list. Tags are also saved into the file's frontmatter. - **Save / Cancel** — Save writes the file and shows a toast with an **Open** action that jumps to the Inbox. Cancel discards the draft. ## The Inbox tab The Inbox tab is the triage workspace. Open it from the bottom nav (the **Inbox** icon), or by tapping the Inbox label at the top of the Quick Capture sheet. ### Three modes A pill segmented control at the top of the page switches between: | Mode | What it shows | |------|---------------| | **Active** | Captures that are not done and not currently snoozed. Sorted by pinned → priority → newest. | | **Snoozed** | Captures with a future wake time. Sorted by soonest wake. | | **Done** | Captures you've marked done. Sorted by most recently completed. | Each segment shows a count, so you always know how much is waiting in each lane. ### The card stack The current capture sits on top of a small stack — up to two peek cards behind it indicate "there's more to come." Each card shows: - The capture date (or the snooze wake time, if it's snoozed) - A position counter (e.g., `2 / 14`) when the queue has more than one item - Priority badge and any inbox tags - A live preview of the body, with full Markdown rendering **Swipe left** to advance to the next card; **swipe right** to go back. The card rotates and fades as you drag, then throws off-screen on commit. The card stack moves underneath in the same gesture, so there's a visible sense of progress through the queue. Tap a card to open it for editing. ### Action bar A persistent action bar at the bottom of the screen drives triage. The buttons change based on which mode you're in: | Button | Active | Snoozed | Done | |--------|--------|---------|------| | **More** (···) | Convert / Append / Delete | Convert / Append / Delete | Convert / Append / Delete | | **Later** | Snooze | Re-snooze | — | | **Done** / **Wake** / **Reopen** | Mark Done | Wake now | Reopen | | **Undo** | Undo last action | Undo last action | Undo last action | Undo holds up to ten recent actions in memory, so you can step back through Done and Snooze decisions made in the current session. ### Snoozing for later Tap **Later** to open the snooze sheet. Five presets are calculated relative to the current time: - **Later today** — three hours from now - **This evening** / **Tomorrow evening** — 8 PM (today if it hasn't passed, otherwise tomorrow) - **Tomorrow morning** — 9 AM tomorrow - **This weekend** — 9 AM next Saturday - **Next week** — 9 AM next Monday Each option shows the day and time it resolves to so you don't have to do the math. When the wake time arrives, the capture rejoins the Active queue automatically. ### More actions Tap **More** (···) to open the secondary actions sheet: - **Convert to note** — opens a sheet where you can confirm the title (pre-filled from the first line) and pick a destination folder. The capture is rewritten as a normal note in your workspace and Octarine navigates to it. - **Append to today's daily note** — appends the body to the bottom of today's daily note (creating it if needed). The capture is then marked done so it leaves the Active queue. - **Delete capture** — removes the capture file. Destructive and not undoable from the action bar. ## Editing a capture Tapping a card in the stack opens a dedicated edit page. It uses the same editor as regular notes but layers inbox-specific controls in the header: - A priority badge (tap to change) - A tag picker (tap to set or remove a tag) - A done toggle - A ··· menu with the same Convert / Append / Delete actions The page swipes back from the left edge to return to the triage view. ## Searching captures The magnifying glass in the Inbox header opens a search dialog that filters across all captures (Active, Snoozed, and Done) by body content. Tap a result to jump straight to the edit page for that capture. ## Configuring Capture Tags The chips inside Quick Capture are powered by your **Capture Tags** list, configured per-workspace. Open **Settings → Inbox** to manage them: - Add up to **5 tags**. Tags are normalized to lowercase, kebab-case, and capped at 24 characters. - Tap the **×** next to a tag to remove it. - The default starter list is `follow-up`, `read-later`, and `idea`. These tags only affect the Inbox capture flow. They're stored in the workspace settings and don't appear in the global tag index unless you actually save a capture with one applied. ## Where captures live on disk Each capture is a Markdown file under `.octarine/inbox/` in your workspace. The filename is a timestamp, which gives a stable sort and avoids collisions: ``` .octarine/inbox/2026-04-29_14-32-08-217.md ``` The body is plain Markdown. Triage state (priority, tags, done, snooze, etc.) is stored in YAML frontmatter at the top of the file: ```yaml --- priority: high tags: - follow-up done: false created_at: 2026-04-29T14:32:08.217Z snoozed_until: 2026-04-30T09:00:00.000Z --- ``` Because they're plain files, captures sync via iCloud alongside the rest of your workspace and stay accessible from the desktop app. #### Quick Answers ### Where are iOS inbox captures stored? Captures are Markdown files under `.octarine/inbox/` inside your workspace. ### Can iOS captures sync to desktop Octarine? Yes. Because captures are plain files in the workspace, they can sync through iCloud and remain accessible from the desktop app. ### Can I convert an iOS inbox capture into a note? Yes. Use **Convert to note** from the More menu to turn a capture into a normal workspace note.