Categorygithub.com/DavidEsdrs/keep
modulepackage
0.0.0-20240713202137-ccee95a950a2
Repository: https://github.com/davidesdrs/keep.git
Documentation: pkg.go.dev

# README

keep šŸ“”

🌟 Keep notes with ease 🌟

Keep is a CLI tool that helps you to keep short notes. Simple as that.

Usage šŸ”

Below are some example usages for keep.

Create note:

keep "this is a note"

Keep allows you to create groups to organize notes. To create a group, you must give a title and a description as follow:

keep group "books" "Here are some books that I want to read"

To store a note in a group you can do as follow:

keep "books" "Programming Language Pragmatics"

To read all notes from a group do:

keep read books

If you want to list all groups you've created:

keep list

Installation

Download a build from download page here in github. After that, the installation depends on your operating system.

For linux: 1 - Move the app binary into /usr/bin

sudo mv ~/Downloads/keep /usr/bin/keep

2 - Give execution permission for the binary:

chmod -x /usr/bin/keep

3 - Restart your terminal session. 4 - Enjoy!

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
return the directory in which the files from keep must be stored.
GetKpsHeader returns the header of a .kps binary file and a nil error if it has success.
No description provided by the author
No description provided by the author
creates a new file named [title].kps with starting values.
No description provided by the author
OpenOrCreate opens or creates the file if it doesn't exist.
ReadAllNotes emits all notes stored within a .kps file.

# Variables

No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author