muninn-cli v2.3.0

muninn

muninn is a set of utilities helping me build and navigate my personal flat-file markdown wiki.

This is personal software project, shared mainly as a reference point. I wont be fixing bugs that don't happen to me, or add functionalities I don't want/need.

I'm using it in combination with muninn-vim.

Assumptions

• wiki is markdown based
• links between notes are made using standard markdown linking: linking to [this note](./this-note.md) (spaces in filename should be escaped with \)
• todos are create with gfm: - [ ] a todo, - [x] done todo
• additional support for @tags: - [ ] a todo with scheduled date @due(2020-02-17) @important
  • @due() tag value is formatted YYYY-MM-DD
  • @due() tags matching todays date are highlighted in green in the UI
  • muninn tasks depends on @due() tags

Installation

1. npm install -g muninn-cli
2. muninn config, and set:

{
  "dir": "/Users/Me/Dropbox/Wiki/" // or wherever the wiki is
}

Usage

• muninn tasks - lists tasks (using - [ ] some task @due(YYYY-MM-DD) format) n days into the future:

  • muninn tasks displays all tasks, formatted for CLI
  • muninn tasks --days 2 displays tasks for today and tomorrow
  • muninn tasks --vim displays vim-formatted list

• muninn backlinks - roam-like backlinks (both markdown-links and text search)

  • muninn backlinks --file Notes/Zettels/memex.md displays all backlinks linking to this file, assuming first line starting with # title is the title
  • muninn backlinks --file Notes/Zettels/memex.md --vim same as above but vim-formatted

• muninn get-asset - quick assets adding:

  • if URL then download into .assets (support for images mainly)
  • if local file then copy into .assets
  • returns markdown embed fragment for including into a note
  • file is addressed by hash of the content

• muninn ui - starts read-only UI

  • muninn ui --port 3000 - runs on specified port