ncli - Note taking in the terminal

Take quick notes from your terminal without needing external tools.

Warning

This is a work in progress project and only tested on windows.

Usage:

Currently it contains an interactive mode and a cli mode. In interactive mode it works like a simple shell, in cli mode you can chain various commands to change the state.

notes add "this note is cool" p other_project ls

The above command performs an add, a sw and a ls operation in a single cli command. More info can be obtain with notes help.

isn't finished and why?

• Support for multiple projects;
  • tags;
• Note taking:
  • add;
  • remove;
  • edit;
  • link;
  • copy;
  • move;
  • tags;
• Filters;
  • select
• GUI version;
• WEB version (WASM);

Current operations:

command	description	hidden behavior
np	create new project	sets the current project to the newly created project
del	delete project	clears the current project. use sw afterwards
ls	list notes	-
lsp	list projects	-
lsi	list notes with index	-
sw	switch current project	-
addn | an | add	add note to current project	-
rn | rm	remove the note at the given index	-
cp	print info about current project	-
backup	create a cpy of the working file.	-
tag	tags the note at index with given tag	-
rename	renames project from old to new	if current project is old sets current project to new
sel	list all notes with tag	-
exit	exits the cli	-
help | h	display help	-

Building:

The "app" is written in Odin, so we use the Odin compiler. I know, smart.

> build.bat release

Where it saves the notes, How and Why:

• Where: Notes are currently saved in %APPDATA%/notes-global/global.bin.
• How: It uses a custom file layout that is encoded and decoded. The save and load functionality is available at filedata.odin.
• Why: Using any sort of sql or other type of databases requires the user to have it installed, having local files are easier to mantain and the migration is done when versions missmatch, at least, that is the plan.

FileLayout:

The currently working layout is version 1.

NFILE {
    [5]u8 magic;
    u8 version;

    String current_project_name;
    
    u16 num_of_projects;
    [num_of_projects]Project;
}

Project {
    String project_name;

    u16 number_of_notes;
    [number_of_notes]Note;
}

Note {
    String note;
    u16 tags_len;
    [tags_len]String tags;
}

String {
    u16 len;
    [len]u8 data;
}