updated README

master
Sina Siadat 9 years ago
parent 5ab82abbae
commit 4f67026669

@ -16,59 +16,94 @@ eton is a note-taking cli tool.
```shell
# display the help message
eton -h
```
### new
```shell
# quick add
eton new 'eton is simple'
eton new 'https://...
eton new '[ ] try eton'
# create a new note and open $EDITOR to edit it
# create a new note using $EDITOR
eton new
# edit the last item
eton edit
# add from STDIN
ps aux |eton new -
# add text from STDIN
ps aux | eton new -
# add files
eton addfile file1.txt file2.txt
find -type f |eton addfile -
```
# add a file
eton addfile file.txt
### edit
# use the alias instead of its id
eton show 2
```shell
# edit last item
eton edit
# edit items
eton edit processes 1
```
### alias
```shell
# set a unique alias
eton alias 2 procs
eton alias 3 procs
# use the alias, so you don't need to remember its id
eton cat procs
eton edit procs
eton show procs
# you can rename an alias
# rename an alias
eton alias procs processes
# list all items
eton ls -a
# remove an alias
eton unalias processes
```
### mark
# filter items containing words "word1" AND "word2"
eton ls word1 word2
```shell
# mark an item
eton mark processes
# you can mark specific items
eton mark processes 1
# unmark an item
eton unmark processes
```
# only list marked items (short mode)
eton ls -s
### ls
# edit items
eton edit processes 1
```shell
# list recent items
eton ls
# alias matching is fuzzy for these commands: cat, show, edit, mark, unmark
eton cat prcs
# filter items containing words "eton" AND "simple"
eton ls eton simple
# list all items
eton ls -a
# only list marked items (short mode)
eton ls -s
# pass items to xargs as filenames:
eton ls '[ ]' -l |xargs -i less {}
```
Notes are stored in `~/.etondb`
### more
```shell
# alias matching is fuzzy for these commands: cat, show, edit, mark, unmark
eton cat prs
# view items 1, 2, and 3 using less
eton show 1 2 3
# Notes are stored in `~/.etondb`
echo 'SELECT * FROM attributes LIMIT 10;' |sqlite3 ~/.etondb
```

Loading…
Cancel
Save