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

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

without pip (old method)

1. clone this repo and cd into it.
2. run install_local.sh
3. add ~/.local/bin to path if needed. (help)

usage

adding notes

to add note to a specified table, run this:

makenote [-t <table_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

this tool can also get input from stdin. so you can add notes like this:

echo "I installed makenote tool" | makenote --table journals

if you do not specify table_name, then note will be stored in default table which is journals.

creating tables

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

to create a table, run this:

makenote --create <table_name>

in which <table_name> is the name of table you want to be created.

listing tables

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

makenote --list

showing records

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

makenote --show [<table_name>]

if you do not specify table_name, the default table will be shown.

getting help

run:

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.