blob: 8dc42ebdd94569324f113af0b4187f45ba255fd2 (
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
#+title: Ftag: organize files by giving them tags
* Disclaimer
This project is not quite finished yet. You may see in the Makefile that the
version number has not reached 1.0. Nevertheless, it has come to a usable state
and I start using it myself. I think it may be useful to someone else so I
publish it.
* What is Ftag
I have struggled for a long time to properly manage my administrative
documents. What I mean by /managing/ is:
- being able to quickly find any file based on what is about (appartment,
job...);
- same based on date;
- not having to duplicate files (e.g. my car insurance being in the directory
=car= as well as =insurance=);
- have a convenient way of packaging a few of them into an archive to send to
someone.
I createed Ftag in order to make the above easier. On top of that, I tried to
build Ftag in a way that:
- is command-line based;
- is composable with standard tools (=grep=, =find=, ...);
- allows encryption of documents;
- allows synchronizing the data on multiple machine.
* Installation
#+begin_src console
$ git clone https://tristanriehs.fr/git/ftag
$ cd ftag
$ make
# make install
#+end_src
* Getting started
** Initialize Ftag
#+begin_src console
$ ftag init
#+end_src
** Add a document to the database
This will prompt for some information about the file and encrypt it with your
default GPG key. Run ~ftag file add -h~ for more information.
#+begin_src console
$ ftag file add ~/documents/id_card.pdf
#+end_src
From now, let's say you entered the full name "ID Card" and the canonical name
"id_card".
** Create a tag
#+begin_src console
$ ftag tag add id Identity
#+end_src
** Add this tag to the file
#+begin_src console
$ ftag file tag id_card id
#+end_src
** Done!
You have set up your Ftag database. You can check by querying it.
#+begin_src console
$ ftag query -t id
#+end_src
** Going further
This was a hello-world walk-through. You may get advices about how to insert
numerous existing files to a Ftag database by running ~ftag file add -h~.
|
