summaryrefslogtreecommitdiff
path: root/README.md
blob: 41007eda82f3ea15991993182f3034c0e6015c4d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Manage your notes with pnote!

## About

*pnote* is a text file, format agnostic, note manager.
It allows to keep a consistant hierarchy of note files that you can work with.

## Getting started
Installation:
```
> pip install pnote
```

Create a new project:
```
> pnote -d ~/mynotes
> # See configuration in ~/mynotes/config.json
> # If -d not specified, ${HOME}/.pnote will be used
```

Open and edit today's note file:
```
> pnote -d ~/mynotes -t
```

## Features

Search for files:
```
> pnote -d ~/mynotes search -h
```

Tag files:
```
> pnote -d ~/mynotes tag -h
```

Manage your project:
```
> pnote -d ~/mynotes admin -h
```

Export your notes:
```
> pnote -d ~/mynotes search --subpath | pnote -d ~/mynotes export --json
> pnote -d ~/mynotes search --subpath | pnote -d ~/mynotes export --template template.txt
```

For more information on *pnote*:
```
> pnote -h
```