Skip to content

robotman40/oxnotes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Oxnotes - Simple CLI Note Taking

Written in Rust, Oxnotes is a simple and efficient note taking program that runs in your command line. Use your favorite text editor (i.e. Nano, Edit) to open your notes and take them down quickly.

How to Use

The program is incredibly simple to use. Notes are simply split into categorized and uncategorized ones.

Uncategorized Notes

To create an uncategorized note, run this command:

oxnotes add note "My First Note"

Then we can open it with this command:

oxnotes open "My First Note"

If we want to list all uncategorized notes, run this command:

oxnotes list notes

To delete an uncategorized note, execute this:

oxnotes delete category "My First Note"

Categorized Notes

You are able to categorize notes by creating categories. For example, we can create a category with this command:

oxnotes add category "Lecture Notes"

Then we can create a note in that category with this command:

oxnotes add note "Lecture Notes" "Lecture 1"

Finally, we open it with this command:

oxnotes open "Lecture Notes" "Lecture 1"

If we want to list all categories, run this command:

oxnotes list categories

and if we want to list all notes within a category:

oxnotes list notes "My Category"

To delete a note in a category:

oxnotes delete note "Lecture Notes" "Lecture 1"

But to delete an entire category, including all its content, run this:

oxnotes delete category "Lecture Notes"

Install

Currently, you can compile this program for Windows and Linux via Cargo (MacOS support is planned, but is not currently in the works) and manually install it yourself.

But I also provide installation programs in the releases for the aforementioned platforms. Use this for the quickest setup.

On Windows, it uses Edit, which is only preinstalled on Windows 11 Insider Builds. To install it, run winget install Microsoft.Edit.

Planned Features

  • Configuration Utilities
  • MacOS Support

About

A simple, cross-platform note taking app written in Rust

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages