Octarine

https://docs.octarine.app
Admin
Octarine is a fast, private markdown editor designed to help you capture ideas, organize knowledge,...
Tokens:36,289
Snippets:558
Trust Score:7.4
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example with Callbacks

Source: https://docs.octarine.app/workflows/uri-scheme

Illustrates how to use x-callback-url with Octarine for success and error handling, including examples for Apple Shortcuts and webhooks.

```APIDOC
### Example with Callbacks

**Apple Shortcuts - Run another shortcut on success:**
```
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:**
```
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:**
```
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

```
```

--------------------------------

### Daily Standup Template Example

Source: https://docs.octarine.app/workflows/uri-scheme

Example of replacing a note's content daily with a fresh standup template.

```uri
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
```

--------------------------------

### AI Update List Example

Source: https://docs.octarine.app/workflows/uri-scheme

Example of adding an AI-generated update to a note, appending it to the top.

```uri
octarine://create?path=inbox/claude-updates&content=%23%23%20Jan%203%2C%202026%0A%0A-%20Completed%20feature%20X&position=top
```

--------------------------------

### Example .octarineignore File

Source: https://docs.octarine.app/working-with-ai/ask-octarine

This snippet shows an example of how to configure exclusions for Ask Octarine. Each line specifies a file or folder to be ignored by the AI search.

```text
# Ask Octarine exclusions
Private
Research/Unpublished.md
.templates

```

--------------------------------

### Claude/AI Assistant Integration Example

Source: https://docs.octarine.app/workflows/uri-scheme

An example URI for saving AI-generated research summaries to Octarine. It includes a path and content, with content pre-encoded.

```text
To save this information to your notes, use:
octarine://create?path=inbox/ai-research&content=%23%23%20Research%20Summary%0A%0A...&position=top

```

--------------------------------

### Install Codex CLI

Source: https://docs.octarine.app/working-with-ai/working-with-codex

Ensure the Codex CLI is installed and accessible from your terminal. The first run prompts for authentication.

```bash
codex

```

--------------------------------

### Start Ollama Service

Source: https://docs.octarine.app/working-with-ai/working-with-ollama

Run the Ollama server locally. This command starts the service on http://localhost:11434 by default and must remain running for Octarine to connect.

```bash
ollama serve

```

--------------------------------

### Project Note Type Example

Source: https://docs.octarine.app/note-management/note-types

Use this type when a note serves as a central hub for a specific piece of work. It tracks status, owner, start date, and target date.

```yaml
---
oct.type: project
Status:
  - Active
Owner: [[People/Rajat]]
Start Date: 2026-06-01
Target Date: 2026-07-15
tags:
  - product
---
```

--------------------------------

### Verify Git Installation

Source: https://docs.octarine.app/backup/git-sync

Run this command in your terminal to check if Git is installed on your system. If not, your system may prompt for automatic installation.

```bash
git -v
```

--------------------------------

### Example Skill: Release Notes

Source: https://docs.octarine.app/working-with-ai/skills

This skill provides instructions for writing release notes targeted at users, emphasizing clear headings, short sections, and avoiding internal implementation details.

```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.


```

--------------------------------

### DateTime Property Examples

Source: https://docs.octarine.app/note-management/properties

Demonstrates the DateTime property type for precise timestamps where time is relevant.

```markdown
Last Edited: 2025-09-23T09:42
Meeting Time: 2025-09-23T15:30


```

--------------------------------

### Note with YAML Frontmatter Properties

Source: https://docs.octarine.app/note-management/properties

Example of a note file with properties defined in YAML frontmatter, including various property types.

```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...


```

--------------------------------

### String Property Examples

Source: https://docs.octarine.app/note-management/properties

Demonstrates the use of the String property type for text-based metadata, including wikilink support.

```markdown
Author: Jane Smith
Summary: Meeting notes about project timeline
Related to: [[Project Alpha]]


```

--------------------------------

### Open Daily Note with Success Callback to Webhook

Source: https://docs.octarine.app/workflows/uri-scheme

Example of opening a daily note and triggering a webhook on success. The webhook will receive status and path information.

```text
octarine://daily?date=today&content=Task%20complete&x-success=https://example.com/webhook?status=done
```

```text
# On success, opens in browser:
https://example.com/webhook?status=done&path=Daily/2026-01-06.md&action=appended
```

--------------------------------

### Example Octarine URL

Source: https://docs.octarine.app/workflows/uri-scheme

This is an example of a deep link URL for opening a specific note within a workspace. Ensure special characters are URL-encoded.

```url
octarine://open?path=notes%2Fmeeting.md&workspace=My%20Workspace
```

--------------------------------

### List Property Examples

Source: https://docs.octarine.app/note-management/properties

Shows the List property type for predefined dropdown options, supporting multiple selections and wikilinks.

```markdown
Status:
  - In Progress
  - Under Review
Person:
  - [[Jane Doe]]
  - [[Rajat K]]


```

--------------------------------

### Create Note with Success Callback to Shortcuts

Source: https://docs.octarine.app/workflows/uri-scheme

Example of creating a note and triggering another Apple Shortcut upon successful completion. The 'NoteCreated' shortcut will receive parameters about the created note.

```text
octarine://create?path=inbox/note&content=Hello&x-success=shortcuts://run-shortcut?name=NoteCreated
```

```text
# On success, runs the "NoteCreated" shortcut with parameters:
shortcuts://run-shortcut?name=NoteCreated&path=inbox/note.md&workspace=Personal&action=created
```

--------------------------------

### Markdown Image Link Example

Source: https://docs.octarine.app/importing/apple-notes

Use standard Markdown image links for attachments when paths are correct.

```markdown
![Whiteboard sketch](.attachments/whiteboard-sketch.png)

```

--------------------------------

### Replace daily note content with fresh start

Source: https://docs.octarine.app/workflows/uri-scheme

Replaces the entire content of today's daily note with new content. Creates the note if it doesn't exist.

```uri
octarine://daily?date=today&content=Fresh%20start&fresh=true
```

--------------------------------

### Tags Property Examples

Source: https://docs.octarine.app/note-management/properties

Demonstrates the reserved Tags property type, which syncs with the workspace's tag tree.

```markdown
tags:
  - project-alpha
  - meeting
  - urgent


```

--------------------------------

### Logseq Outliner Formatting Example

Source: https://docs.octarine.app/importing/logseq

This demonstrates how Logseq's nested bullet structure can be converted into Markdown headings for better readability in Octarine.

```text
- Project plan
  - Goals
  - Risks

```

--------------------------------

### Example Folder Structure for Agenda Export

Source: https://docs.octarine.app/importing/agenda

A suggested folder structure for organizing exported Markdown files from Agenda before importing them into Octarine.

```text
Agenda Export/
  Work/
  Personal/
  Archive/

```

--------------------------------

### Task Note Type Example

Source: https://docs.octarine.app/note-management/note-types

Use this type for actionable items that progress from 'not done' to 'done'. It includes fields for status, priority, due date, and completion.

```yaml
---
oct.type: task
Status:
  - In Progress
Priority: 2
Due Date: 2026-06-18
Completed: false
tags:
  - launch
---
```

--------------------------------

### Create Note with Error Callback to Alert URL

Source: https://docs.octarine.app/workflows/uri-scheme

Example of attempting to create a note and triggering an alert URL if an error occurs. The alert URL will receive error details.

```text
octarine://create?path=important/note&content=Data&x-error=https://example.com/alert?type=octarine-error
```

```text
# On error, calls:
https://example.com/alert?type=octarine-error&errorCode=save_failed&errorMessage=Error%20saving%20file
```

--------------------------------

### URL Encoding Example

Source: https://docs.octarine.app/workflows/uri-scheme

Demonstrates how to encode markdown content for inclusion in a URI. Special characters like spaces, newlines, and symbols are converted to their percent-encoded equivalents.

```markdown
# Original content:
## Heading

- Item 1
- Item 2

# URL encoded:
octarine://create?path=test&content=%23%23%20Heading%0A%0A-%20Item%201%0A-%20Item%202

```

--------------------------------

### Reading Note Type Example

Source: https://docs.octarine.app/note-management/note-types

Ideal for collecting and referencing source materials. It includes fields for the source URL, author, status, rating, and relevant tags.

```yaml
---
oct.type: reading
Source: https://example.com/article
Author: Jane Smith
Status:
  - To Summarize
Rating: 4
tags:
  - research
  - product
---
```

--------------------------------

### Template Variables Example

Source: https://docs.octarine.app/organization/templates

Demonstrates the use of inline variables for dynamic content insertion in templates. Variables like {{title}}, {{date}}, and {{time}} are supported, with custom formatting options for dates and times.

```markdown
# {{title}}

Created: {{date:MMMM d, yyyy}} at {{time}}


```

--------------------------------

### Example Skill: Research Synthesizer

Source: https://docs.octarine.app/working-with-ai/skills

This skill guides the AI to identify recurring themes, contradictions, and concrete examples in research, separating facts from interpretation, and concluding with open questions.

```markdown
Look for recurring themes, contradictions, and concrete examples.
Separate facts from interpretation.
End with open questions worth following up on.


```

--------------------------------

### Create Web Link

Source: https://docs.octarine.app/editor/formatting

Use the Markdown syntax `[Link](http://example.com)` to create a web link. There is no specific keyboard shortcut for this.

```markdown
[Link](http://example.com)
```

--------------------------------

### Create Task List

Source: https://docs.octarine.app/editor/formatting

Use the Markdown syntax `[] text` or the keyboard shortcut `Cmd/Ctrl + Shift + 9` to create a task list item.

```markdown
[] text
```

--------------------------------

### Create Note Using Template

Source: https://docs.octarine.app/workflows/uri-scheme

Creates a note using a specified template for initial content. Template files with `.md` extension are also supported.

```uri
octarine://create?path=meetings/standup&template=meeting-notes
```

```uri
octarine://create?path=projects/new-project&template=project-template.md
```

--------------------------------

### Create Note with Content

Source: https://docs.octarine.app/workflows/uri-scheme

Creates a note with specified content. If the file exists, content is appended by default.

```uri
octarine://create?path=inbox/task&content=%23%20New%20Task%0A%0A-%20%5B%20%5D%20Item%201
```

--------------------------------

### Checkbox Property Examples

Source: https://docs.octarine.app/note-management/properties

Illustrates the Checkbox property type for boolean true/false values.

```markdown
Published: true
Archived: false


```

--------------------------------

### Run AppImage Application

Source: https://docs.octarine.app/getting-started/installation

Execute the AppImage file to launch Octarine on Linux after making it executable.

```bash
./Octarine_<version>_amd64.AppImage

```

--------------------------------

### List Downloaded Ollama Models

Source: https://docs.octarine.app/working-with-ai/working-with-ollama

View all the models that have been downloaded and are available for use with Ollama.

```bash
ollama list

```

--------------------------------

### Number Property Examples

Source: https://docs.octarine.app/note-management/properties

Illustrates the Number property type for quantitative data like counts or scores.

```markdown
Word Count: 1250
Priority: 5
Rating: 8.5


```

--------------------------------

### Get Current Note for Hookmark

Source: https://docs.octarine.app/workflows/uri-scheme

Retrieves the current note's information specifically for integration with Hookmark.

```uri
octarine://getCurrentNote?x-success=hookmark://x-callback-url/setBookmark
```

--------------------------------

### Apply Heading 1 Formatting

Source: https://docs.octarine.app/editor/formatting

Use the Markdown syntax `# text` or the keyboard shortcut `Cmd/Ctrl + Option/Alt + 1` to create a Heading 1.

```markdown
# text
```

--------------------------------

### Get Current Note for Apple Shortcuts

Source: https://docs.octarine.app/workflows/uri-scheme

Retrieves the current note's information to be processed by an Apple Shortcut.

```uri
octarine://getCurrentNote?x-success=shortcuts://x-callback-url/run-shortcut?name=HandleNote
```

--------------------------------

### Apply Heading 2 Formatting

Source: https://docs.octarine.app/editor/formatting

Use the Markdown syntax `## text` or the keyboard shortcut `Cmd/Ctrl + Option/Alt + 2` to create a Heading 2.

```markdown
## text
```

--------------------------------

### Creating a Tip Callout

Source: https://docs.octarine.app/editor/callout

Use this syntax to create a 'Tip' callout. You can nest other formatting inside, such as lists, links, and code blocks.

```markdown
> [!TIP]
> You can nest other formatting inside callouts, including lists, links, and even code blocks.

```

--------------------------------

### Octarine Wikilink Example

Source: https://docs.octarine.app/importing/noteplan

When using notes inside folders, Octarine wikilinks must include the path from the workspace root.

```markdown
[[Projects/Launch Plan]]
```

--------------------------------

### Date Property Examples

Source: https://docs.octarine.app/note-management/properties

Shows the Date property type for representing dates without specific times, suitable for deadlines.

```markdown
Due Date: 2024-03-15
Publication Date: 2024-04-01


```

--------------------------------

### Make AppImage Executable

Source: https://docs.octarine.app/getting-started/installation

Use this command to grant execute permissions to the downloaded AppImage file on Linux.

```bash
chmod +x Octarine_<version>_amd64.AppImage

```

--------------------------------

### Get Current Note with Local Server Callback

Source: https://docs.octarine.app/workflows/uri-scheme

Retrieves the current note's details and sends them to a local server for testing or processing.

```uri
octarine://getCurrentNote?x-success=http://localhost:9999/callback
```

--------------------------------

### Create daily note using a template

Source: https://docs.octarine.app/workflows/uri-scheme

Creates a daily note using the content from a specified template.

```uri
octarine://daily?date=today&template=daily-template
```

--------------------------------

### Decision Note Type Example

Source: https://docs.octarine.app/note-management/note-types

Useful for maintaining a durable record of why changes were made. It tracks the decision status, date, owner, and the area it pertains to.

```yaml
---
oct.type: decision
Status:
  - Accepted
Decided On: 2026-06-12
Owner: [[People/Rajat]]
Area:
  - Editor
tags:
  - decision
---
```

--------------------------------

### Force Sync via Settings

Source: https://docs.octarine.app/backup/git-sync

An alternative method to manually trigger a sync is through the application's settings menu. This provides direct access to the sync functionality.

```bash
Settings → GitSync → Sync Now
```

--------------------------------

### Get Current Note Info (Generic Callback)

Source: https://docs.octarine.app/workflows/uri-scheme

Retrieves the URL and title of the currently focused note, sending the data to a generic callback URL.

```uri
octarine://getCurrentNote?x-success=myapp://callback
```

--------------------------------

### Create Empty Note

Source: https://docs.octarine.app/workflows/uri-scheme

Creates an empty note or opens an existing one at the specified path.

```uri
octarine://create?path=inbox/new-idea
```

--------------------------------

### Create Codeblock

Source: https://docs.octarine.app/editor/formatting

Use the Markdown syntax ```` text` or the keyboard shortcut `Cmd/Ctrl + Option/Alt + C` to create a code block.

```markdown
``` text
```

--------------------------------

### Apply Heading 3 Formatting

Source: https://docs.octarine.app/editor/formatting

Use the Markdown syntax `### text` or the keyboard shortcut `Cmd/Ctrl + Option/Alt + 3` to create a Heading 3.

```markdown
### text
```

--------------------------------

### Reference External Files with Wikilinks

Source: https://docs.octarine.app/note-management/external-files

Use wikilink syntax to reference external files within your notes. Type '[[' and start typing the filename to see available files.

```markdown
[[Filename.pdf]]
[[project-budget.xlsx]]
[[meeting-recording.mp3]]
```

--------------------------------

### LaTeX Quick Reference: Basic Notation

Source: https://docs.octarine.app/editor/latex

Common LaTeX commands for basic mathematical notation like superscripts, subscripts, fractions, and roots.

```latex
x^2
```

```latex
x_1
```

```latex
\frac{a}{b}
```

```latex
\sqrt{x}
```

```latex
\sum_{i=1}^n
```

```latex
\int_a^b
```

--------------------------------

### Create a Basic Flowchart with Mermaid

Source: https://docs.octarine.app/editor/mermaid

Use this syntax to define a simple flowchart. Mermaid will render the text into a visual diagram.

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Do this]
    B -->|No| D[Do that]
    C --> E[End]
    D --> E
```

--------------------------------

### Apply Bold Formatting

Source: https://docs.octarine.app/editor/formatting

Use the Markdown syntax `**text**` or the keyboard shortcut `Cmd/Ctrl + B` to make text bold.

```markdown
**text**
```
Tokens:
Raw