#notes #cli-applications #unstructured #command-line #search #manage #directory

app scatternotes

A cli application to manage unstructured notes

3 releases

0.1.4 Aug 4, 2024
0.1.2 May 13, 2024
0.1.1 May 13, 2024

#954 in Text processing

Download history 128/week @ 2024-08-04 1/week @ 2024-08-11 15/week @ 2024-09-15 19/week @ 2024-09-22 30/week @ 2024-09-29 3/week @ 2024-10-06

67 downloads per month

MIT license

33KB
937 lines

Scatternotes Cli

A CLI application to create an manage unordered notes.

Best used together with the neovim extension.

Usage

Create notes in a directory (default ~/notes):

This is a #test #note.

You can #create #tags if you just put a #number-sign infront of the word:

    #this-is-a-tag

Tags are used for searching notes.

All notes are stored in the same directory. The names of the files are random.

All commands shown below also have shorthands.
To view them run:

scatternotes --help
scatternotes <command> --help

You can generate new names with:

scatternotes generate
scatternotes generate 20

You can list all notes with:

scatternotes list
scatternotes list --with-tags

You can search for notes with:

scatternotes search <tag1> <tag2> <...> <tagn>
scatternotes search <tag1> <tag2> <...> <tagn> --with-tags

You can commit the notes with:

# message: "update notes"
scatternotes commit

You can clean the notes with:

# delete all notes containing #just-a-test tag
# rename all non confirming notes
scatternotes clean

Installation

You can use cargo to install the cli application.

cargo install --locked scatternotes

Dependencies

~6.5MB
~108K SLoC