1 unstable release
0.1.0 | Mar 21, 2024 |
---|
#24 in #wiki
25KB
388 lines
wiki-o
Smart note taking cli app
Usage
Implemented commands
$ wo --help
Smart note taking cli app
Usage: wo [COMMAND]
Commands:
add Add note
show Show files with similar name
list List all notes
delete Delete a note
purge Purge all notes
pa Piped add note
config Show wiki-o configuration
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
Show configuration
$ wo config
Current configuration:
notes directory: wiki-o/notes
metadata directory: wiki-o/_metadata
file format: md
Add note
$ wo add "hello world"
Added hello world to my_notes
$ wo add "another note" -f=new_file
Added another note to new_file
List
$ wo list
File: <home_dir>/wiki-o/.notes/new_file.md
another note
File: <home_dir>/wiki-o/.notes/my_notes.md
hello world
$ wo list -s=true
File: <home_dir>/wiki-o/.notes/new_file.md
File: <home_dir>/wiki-o/.notes/my_notes.md
Delete
$ wo delete -f=my_notes
Deleted file: <home_dir>/wiki-o/notes/my_notes.md
Purge
$ wo purge
Deleted directory: <home_dir>/wiki-o/notes
Configuration
By default the config file is located under ~/.config/wiki-o
.
# config.toml
notes_dir = "wiki-o/notes"
metadata_dir = "wiki-o/_metadata"
file_format = "md
Piping commands
Instead of adding the command through the add, you can pipe the output that you get from another command directly into wiki-o and save it in a note:
$ echo 'hello world' | wo pa
added hello world to my_notes
$ echo 'hello world' | wo pa -f=new_file
added hello world to new_file
And naturally you can pipe the output from wiki-o commands:
$ wo show -f=new_file > new_file.txt
$ cat new_file.txt
File: new_file.md
hello world
Roadmap
Upcoming features/bug fixes can be found here.
License
Released under GNU General Public License v3.0 by @doriancodes.
Dependencies
~1–12MB
~82K SLoC