Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

obsidian

package

Go to main page

Versions in this module

v0

v0.3.1

Feb 18, 2026

Changes in this version

+ var RunningInWSL = config.RunningInWSL

+ func ApplyDefaultFolder(noteName, vaultPath string) string

+ func DefaultNoteFolder(vaultPath string) string

+ func MomentToGoFormat(momentFmt string) string

type CliConfig

+ DefaultOpenType string

+ type DailyNotesConfig struct

+ Folder string

+ Format string

+ Template string

+ func ReadDailyNotesConfig(vaultPath string) DailyNotesConfig

+ type ObsidianAppConfig struct

+ NewFileFolderPath string

+ NewFileLocation string

type Vault

+ func (v *Vault) DefaultOpenType() (string, error)

+ func (v *Vault) SetDefaultOpenType(openType string) error

type VaultManager

+ DefaultOpenType func() (string, error)

v0.3.0

Feb 12, 2026

Changes in this version

+ const ExecuteUriError

+ const NoteDoesNotExistError

+ const ObsidianCLIConfigDirWriteEror

+ const ObsidianCLIConfigGenerateJSONError

+ const ObsidianCLIConfigParseError

+ const ObsidianCLIConfigReadError

+ const ObsidianCLIConfigWriteError

+ const ObsidianConfigParseError

+ const ObsidianConfigReadError

+ const ObsidianConfigVaultNotFoundError

+ const VaultAccessError

+ const VaultReadError

+ const VaultWriteError

+ var CliConfigPath = config.CliPath

+ var ErrPathTraversal = errors.New("path traversal detected: path must remain within vault directory")

+ var JsonMarshal = json.Marshal

+ var ObsidianConfigFile = config.ObsidianFile

+ var Run = open.Run

+ func AddMdSuffix(str string) string

+ func GenerateBacklinkSearchPatterns(notePath string) []string

+ func GenerateLinkReplacements(oldNotePath, newNotePath string) map[string]string

+ func GenerateNoteLinkTexts(noteName string) [3]string

+ func ListEntries(vaultPath, relativePath string) ([]string, error)

+ func OpenInEditor(filePath string) error

+ func RemoveMdSuffix(str string) string

+ func ReplaceContent(content []byte, replacements map[string]string) []byte

+ func ShouldSkipDirectoryOrFile(info os.FileInfo) bool

+ func ValidatePath(basePath, relativePath string) (string, error)

+ type CliConfig struct

+ DefaultVaultName string

+ type FuzzyFinder struct

+ func (f *FuzzyFinder) Find(slice interface{}, itemFunc func(i int) string, opts ...interface{}) (int, error)

+ type FuzzyFinderManager interface

+ Find func(slice interface{}, itemFunc func(i int) string, opts ...interface{}) (int, error)

+ type Note struct

+ func (m *Note) Delete(path string) error

+ func (m *Note) FindBacklinks(vaultPath, noteName string) ([]NoteMatch, error)

+ func (m *Note) GetContents(vaultPath string, noteName string) (string, error)

+ func (m *Note) GetNotesList(vaultPath string) ([]string, error)

+ func (m *Note) Move(originalPath string, newPath string) error

+ func (m *Note) SearchNotesWithSnippets(vaultPath string, query string) ([]NoteMatch, error)

+ func (m *Note) SetContents(vaultPath string, noteName string, content string) error

+ func (m *Note) UpdateLinks(vaultPath string, oldNoteName string, newNoteName string) error

+ type NoteManager interface

+ Delete func(string) error

+ FindBacklinks func(string, string) ([]NoteMatch, error)

+ GetContents func(string, string) (string, error)

+ GetNotesList func(string) ([]string, error)

+ Move func(string, string) error

+ SearchNotesWithSnippets func(string, string) ([]NoteMatch, error)

+ SetContents func(string, string, string) error

+ UpdateLinks func(string, string, string) error

+ type NoteMatch struct

+ FilePath string

+ LineNumber int

+ MatchLine string

+ type ObsidianVaultConfig struct

+ Vaults map[string]struct{ ... }

+ type Uri struct

+ func (u *Uri) Construct(baseUri string, params map[string]string) string

+ func (u *Uri) Execute(uri string) error

+ type UriManager interface

+ Construct func(baseUri string, params map[string]string) string

+ Execute func(uri string) error

+ type Vault struct

+ Name string

+ func (v *Vault) DefaultName() (string, error)

+ func (v *Vault) Path() (string, error)

+ func (v *Vault) SetDefaultName(name string) error

+ type VaultManager interface

+ DefaultName func() (string, error)

+ Path func() (string, error)

+ SetDefaultName func(name string) error