Note-Mgr (aka nom)

nom is a CLI for managing notes written in markdown. Designed with publishing and searching in mind.

Features

1. Organization: A .index.md file separates drafts from published notes - making it easier to hop into an unfinished draft. .index is also organized A->Z for both lists.
2. Draft Generation: Use the interactive command line to quickly populate the frontmatter for new notes or directly via the command options
3. Publication: A single command will move a note from draft to published. By default the note's frontmatter will be confirmed prior to publication.

Getting Started

To use the CLI, install it globally:

$ yarn global add note-mgr-cli
# or
$ npm install note-mgr-cli --global

At this point, nom will be installed. You can confirm by seeing the help menu

$ nom --help

Before using nom, it must be initialized with nom init

Usage

• -i --init initialize nom
• -n --new will create a new note and add it to the .contents list
• -u --update will update the frontmatter for the selected note
• -r --remove will prompt for a note to remove
• -d --date will interrogate the notes to understand dates of the notes (e.g., publish date)
• -c --count will count the notes based on flags provided

Initialization Options

• "-t --target-dir ", "The relative path to the target directory for notes"

  % nom init -t path/to/target

If no target directory is passed, you will be prompted to provide one in an interactive session.

New Note Options

To create a new note, at a minimum nom requires either a title (-t --title) or to create the note interactively (-i --interactive).

All options are available for setting declaratively with the following options:

• "-c --category ", "The frontmatter for category"

  $ nom new -c "note category"

• "-d --date ", "The frontmatter for publish"

  $ nom new -d 2020-02-20

• "-i --interactive", "Interactively publish a note"

  $ nom new -i

• "-p --publish ", "The frontmatter for publish"

  $ nom new -p 2020-02-20

• "-t --title \