Skip to content

ramseskamanda/quicknote

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quicknote CLI

Latest Release Go Report Card License codecov

About

quicknote is a simple CLI notes app, like jrnl but simpler and in Go!

Menu screenshot Editor screenshot
List your notes Edit notes

Sometimes you just need to write down some notes when you're deep into a sensitive directory and don't want to open a new terminal or use vim. This is is exactly what this is useful for! :)

No markdown, no syntax highlighting, just simple notes notes without leaving the command line.

You can use it to easily write, search, and view notes. Notes are stored as human-readable plain text.

Installation

From source

Make sure you have go>=1.22 installed, then run:

go install github.com/ramseskamanda/quicknote

From package managers

Homebrew

brew tap ramseskamanda/tap
brew install ramseskamanda/tap/quicknote

AUR

pacman -S quicknote

Basic Usage

To create a new note without opening an editor, simply use:

quicknote i really need to remember this!!

If you prefer opening an editor and writing a note over time in a simple, no-nonsense editor, you can do that by using:

quicknote

To see all the notes you've written so far, use:

quicknote --list

Note: you can search (/), delete (ctrl + d), and edit (e/) any note in the list. For more commands, use the help (?).

The editor

You don't have to use the provided editor! It's made for simplicity with minimal key binds and/or distractions. All the notes are saved as .txt files in the $HOME/.local/share/quicknote/ directory so feel free to use any other editor of your choice.

All helpers should be displayed by the application but in case they are not, simply run quicknote --help.

Roadmap

Since this is an open-source project, the release cycles will depend on contributors (and myself). The aim is for this utility always to remain single purpose and easy to use as per the UNIX philosophy.

  • Support custom note directories (incl. remote)
  • Support for $EDITOR
  • Support for tags, titles, and more
  • Support for WYSIWYG editors

If you have any feature requests, please feel free to open a Github Issue and it will be discussed and added to the roadmap.

License

MIT

About

Quick notes from your command line.

Resources

License

Stars

Watchers

Forks

Packages

No packages published