obsidian

package
v0.8.0 Latest Latest
Warning

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

Go to latest
Published: Mar 24, 2026 License: Apache-2.0 Imports: 28 Imported by: 0

Documentation

Overview

Package obsidian implements the ctx journal obsidian subcommand.

It generates an Obsidian vault from journal entries, enabling visual exploration of session history.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildObsidianVault

func BuildObsidianVault(cmd *cobra.Command, journalDir, output string) error

BuildObsidianVault generates an Obsidian vault from journal entries in journalDir and writes the output to the output directory.

Parameters:

  • cmd: Cobra command for output stream
  • journalDir: Path to the source journal directory
  • output: Output directory for the vault

Returns:

  • error: Non-nil if generation fails

func Cmd

func Cmd() *cobra.Command

Cmd returns the journal obsidian subcommand.

Returns:

  • *cobra.Command: Command for generating an Obsidian vault from journal entries

func Run

func Run(cmd *cobra.Command, output string) error

Run generates an Obsidian vault from journal entries.

Pipeline:

  1. Scan entries (reuse core.ScanJournalEntries)
  2. Create output dirs (entries/, topics/, files/, types/, .obsidian/)
  3. Write .obsidian/app.json
  4. Transform and write entries (normalize, convert links, transform frontmatter, add related footer)
  5. Build indices (reuse core.BuildTopicIndex etc.)
  6. Generate and write MOC pages
  7. Generate and write Home.md

Parameters:

  • cmd: Cobra command for output stream
  • output: Output directory for the vault

Returns:

  • error: Non-nil if generation fails

Types

This section is empty.

Jump to

Keyboard shortcuts

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