quicknote

command module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 29, 2024 License: MIT Imports: 2 Imported by: 0

README

quicknote


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

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.

Features

  • CLI args become timestamped notes
  • No args starts an editor that becomes a timestamped note when closed
  • save notes to single file
  • list notes from cli
  • search notes by content
  • Fix editor styling
  • Edit previous notes
  • Save editor without closing
  • Delete previous notes
  • Note titles (v0.2)
  • Full texting (v0.2)

Installation

From source

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

go install github.com/ramseskamanda/quicknote
From package managers

!TODO - https://greeeg.com/en/issues/how-to-create-release-distribute-cli-golang

Basic Usage

Simply use quicknote (personally aliased to qn) and an editor will open for you.

You can also run quicknote my first direct note! and this note will be saved!

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

License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
tui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL