makenote 3.0

command line tool for quickly writing journals

نسخه فارسی این سند

makenote

a command line tool for making diary or journals.

installation

there are a few methods for installation

using pip

easiest way is to install it using pip:

1. install package

pip install makenote

for some new Gnu distros you need to use pipx.

pipx install makenote

2. add ~/.local/bin to path if needed. (help)

build for pip

1. build the package

pip install setuptools wheel
git clone 'https://github.com/ekm507/makenote'
cd makenote
python3 setup.py bdist_wheel

2. install the package

pip install ./dist/*.whl

usage

adding notes

to add note to a specified notebook, run this:

makenote [-t <notebook_name>] <note_text>

in which note text is the note you want to be added.

for example:

makenote I am reading page 754 of the book

if you run this tool with no text, it will get note text from a simple prompt editor. write your text and then hit Alt+Enter or ctrl+D.

$ makenote

it was a great day.
I had a pizza with my friend. (ctrl+D)

1728 - Tue, 10 Bah 1402 18:55:25 - journals - note saved!

if you do not specify notebook name, then note will be stored in default notebook which is journals. you can change it in config file.

creating notebooks

this tool uses different notebooks for storing notes.
for example you can classify your notes in "journals", "tasks", "work", etc.

to create a notebook, run this:

makenote --create <notebook_name>

in which <notebook_name> is the name of notebook you want to be created.

listing notebooks

to get a list of notebooks you have created, run this:

makenote --list

showing records

to see the notes you have stored in a notebook, run this:

makenote --show

if you do not specify notebook name, the default notebook will be shown. you can specify it with -t switch:

makenote --show -t <notebook>

getting help

run command below to get a list of switches:

makenote -h

export all notes

database file is stored in path below:

~/.local/share/makenote/databases/diaryFile.db

for backing notes up, just copy the file into somewhere.

for restoring, just copy the diaryFile.db into the path.