page.man

.\" Manpage for note.
.TH man 1 "30 Nov 2023" "%%VERSION%%" "note man page"
.SH NAME
note \- Simple notes manager
.SH SYNOPSIS

.B note
.I <SUBCOMMAND>
[ARGUMENTS]...
.SH DESCRIPTION
CLI Notes manager.
.SH SUBCOMMANDS
.PP
\fBinit [-p PATH] [-r REMOTE]\fR
.RS 4
Initialize new note storage in PATH(default=~/.notes), if REMOTE specified, pulls notes from there
.RE
.PP
\fBedit|e (PATH_TO_NOTE)\fR
.RS 4
Creates or edit existing note with $VISUAL, after save changes
.RE
.PP
\fBtoday\fR
.RS 4
Creates or edit note with name like daily/06-01-24.md
.RE
.PP
\fBlast\fR
.RS 4
Edit last opened note
.RE
.PP
\fBfedit|fe\fR
.RS 4
Find note by fzf and edit with $VISUAL
.RE
.PP
\fBfgrep|fg\fR
.RS 4
Find note by content with fzf and edit with $VISUAL
.RE
.PP
\fBsync\fR
.RS 4
Pull changes from remote note storage. In case of conflict, accepts yours changes.
.RE
.PP
\fBgit ...\fR
.RS 4
Proxy commands to git
.RE
.PP
\fBlist|ls [PATH_TO_NOTE]...\fR
.RS 4
List notes
.RE
.PP
\fBshow|cat (PATH_TO_NOTE)\fR
.RS 4
Render note in terminal by bat
.RE
.PP
\fBmv (PATH_TO_NOTE) (PATH_TO_NEW_NOTE)\fR
.RS 4
Rename note
.RE
.PP
\fBln (PATH_TO_NOTE) (PATH_TO_LINK)\fR
.RS 4
Create symbolic link
.RE
.PP
\fBrm (PATH_TO_NOTE)\fR
.RS 4
reletes note and commits
.RE
.PP
\fBexport\fR
.RS 4
Export notes in tar.gz format, redirects to stdout (use note export > notes.tar.gz)
.RE
.PP
\fBtree [PATH_TO_SUBDIR]\fR
.RS 4
Show tree of notes in storage or subdirs
.RE
.PP
\fBcomplete (command)\fR
.RS 4
Autocomplete helper
.RS 4
.B Subcommands
.PP
.RS 4
\fBedit|show|render\fR
.RS 4
Print all stored notes without sub directories
.RE
.PP
\fBtree|mkdir\fR
.RS 4
Print only sub directories
.RE
.PP
\fBmv|rm|ls\fR
.RS 4
Print all stored notes with sub directories
.RE
.PP
\fBbash\fR
.RS 4
Print subcommands in bash complete format
.RE
.PP
\fBzsh\fR
.RS 4
Print subcommands in zsh complete format

.SH EXAMPLES

$ note init -r ssh://remote/notes-storage

$ note edit someNote.md

$ note show someNote.md

.SH OPTIONAL DEPENDENCIES
python-grip, bat

.SH EXIT STATUS
0   if OK

1   General error

2   Invalid argument (etc. note not exists, ...)

3   Invalid option

4   Invalid state (etc. not initialized, ...)

.SH ENVIRONMENT
.B VISUAL
The name of the editor
.PP
.B EDITOR
Alternative editor. Used if
.BR VISUAL
not defined
.PP
.B NOTEPAGER
Previewer for notes. Used for
.BR note
.BR show
command
.PP
.B PAGER
Alternative previewer for notes. Used for
.BR note
.BR show
command if
.BR NOTEPAGER
not defined
.PP
.B DATE_FMT
Used for
.BR note
.BR today
command to format daily note name
.PP

.SH AUTHOR
Kan (thek4n@yandex.ru)
https://github.com/thek4n