shellnotes/docs/github

Shellnotes

A easy, simple and fast way to keep notes via your linux terminal.

What is shellnotes?

Shellnotes is a command-line note-taking app for linux users. Shellnotes uses your favourite text editor to save notes on the go. With shellnotes, you can make, find, list, edit or delete your notes from wherever you are, whenever you want. You can use a variety of tools to manipulate your notes and extract data from them.

Why use shellnotes?

Here's why:

• Shellnotes is open source.
• It can suit both dynamic and regular users, as it brings both CLI and GUI experiences.
• It runs exclusively in your terminal, its source files are stored in your home folder.
• It's lightweight
• It's more than just a program for taking notes.. It has a ton of other interesting abilities.
• It's portable and compatible with most shells.
• Even if you delete shellnotes, your notes will stay where they are.
• It has a simple file organization system and CLI.
• It's easy to install, delete and update.
• It's mostly written in shell, which is one of the most commonly used apps to build Linux apps.

How to install

After downloading the source code, navigate to the folder where it's stored, and execute the install script (install.sh), using the sh command.

user@device:~$ cd Downloads
user@device:~/Downloads$ ls
shellnotes-master
user@device:~/Downloads$ cd shellnotes-master
user@device:~/Downloads/shellnotes-master$ ls
bash_update.sh  docs   install.sh  set_defaults.sh  uninstall.sh  util
def             image  logs        shellnotes.sh    update.sh     ver

user@device:~/Downloads$ sh install.sh
[sudo] password for user: ******
#installation starts

for more information, make sure to check out the installation documentation.

How to configure shellnotes

Shellnotes lets you use your favourite text-editor to take your notes, and your prefered directory to save your notes, from where shellnotes will delete them, read them, or list them.

How shellnotes works with text-editors

There are to ways to write a note with shellnotes:

1. Using a GUI editor or IDE, such as Sublime Text, or Visual Studio Code.
2. Using an in-terminal editor.

The Default Note Editors

Shellnotes comes with two default editors, which you can download or change. These are:

1. SnE.
2. nano, for in-terminal notes.

Change default editors

Shellnotes does not require the user to have the above editors. You can always check the current editors or change them. After installing shellnotes, open your terminal, and type shellnotes --set-defaults. This will trigger the shellnotes configuration tool. Choose an option:

1. Select default GUI editor for regular notes.
2. Select in-terminal editor for instant notes.
3. Select default path for saving your Notes.

After selecting an option, write the name of the program you want to set as a new default GUI/terminal editor. It must be valid. (i.e. code for VSCode, subl for Sublime Text) Shellnotes will automatically locate the program's location and apply the changes. If the name is invalid, the operation will stop.

How shellnotes works with directories

Shellnotes will create a new directory in your home folder named "Notes", where it will store all your notes. Every time you open your terminal, it will check whether this folder exists, and create one if not.

Change default Note folder

To change the default note path, type shellnotes --set-defaults in the terminal, or run the file set_defaults.sh from ~/.shellnotes/ manually. Select option 3 to change the default Notes folder, or option 4 to check the current one. If you choose option 3, type a valid relative path to the new directory with permissions given. Shellnotes will automatically change the default folder to the new one. Your notes will be transfered there as well!

Note: You can check the current Notes folder either via "shellnotes -sd, option 4", or "listnotes --folder".

Taking your first note

You can either use newnote for regular notes, or quicknote for an in-terminal experience.

Using newnote

Open a terminal window after installing shellnotes. Type newnote and the name of the new note's name. If you don't set a name after the command as a parameter, shellnotes will ask you for it with a dynamic input. It should look like this:

user@device:folder$ newnote helloWorld

or:

user@device:folder$ newnote
Enter note name: helloWorld

Then, the default regular notes editor window will pop-up. Take your notes, save the file, done!

Using quicknote

Open the terminal. Type quicknote and the name of the new note's name. If you don't set a name after the command as a parameter, shellnotes will ask you for it again. It's similar to newnote:

user@device:folder$ quicknote helloWorld => no extension needed!

or:

user@device:folder$ quicknote
Enter note name: helloWorld

quicknote will then open the default quick notes editor. Now you can start saving your notes via terminal.

Reading notes

You can also read your notes in a similar way, using readnote and quickread. See more in the commands file.

Learn everything shellnotes can do

shellnotes is more than just that. Here's some documentation you might be interested in:

• how to delete shellnotes
• how to disable or enable shellnotes
• how to update shellnotes
• how to set the default note editors and Note folder for shellnotes
• learn how to use shellnotes' auto-update feature
• learn shellnotes' commands
• learn which files to run manually if needed
• contact the author
• check the software requirements
• see the license
• see what versions are supported
• get more info about shellnotes
  Want even more information? Feel free to see the whole shellnotes documentation!

Warnings!

WARNING: The default shell for shellnotes is bash. However, shellnotes will find your shell if it's different and continue installing according to it. If your shell is not supported though, the installation will fail. WARNING: install.sh must be run from the folder where it was downloaded WITH the other files from the repo. Otherwise, installation will fail. (see installation documentation for more).