Skip to content
/ notes Public

A command-line tool for efficiently managing personal notes, allowing you to add, list, edit, and delete notes with simple commands.

Notifications You must be signed in to change notification settings

isakruas/notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Useful Commands for Personal Notes

Adding a Note

To add a new note, you have two options:

  • Run the command and interactively provide the title:
    make add
  • Provide the title directly in the command:
    make add TITLE="Your Note Title"

Listing Notes

To list all your notes grouped by prefix, use:

  • Simply list all notes:
    make list
  • List notes using a keyword search:
    make list SEARCH="keyword"

Editing a Note

To edit an existing note, use:

make edit

You will be prompted to enter the note's name, and it will open in your default text editor.

Cleaning Up

To remove all notes, use:

make clean

You will be asked for confirmation before proceeding with the deletion.

Formatting Notes

To ensure all lines in your notes are no longer than 80 characters, use the format command. This helps improve the readability of your notes by breaking down long lines:

make format

This command reformats each note file by wrapping lines at word boundaries, ensuring a maximum line length of 80 characters.

Display Help Information

For more information on available commands and usage, use:

make help

About

A command-line tool for efficiently managing personal notes, allowing you to add, list, edit, and delete notes with simple commands.

Topics

Resources

Stars

Watchers

Forks