orvanitag/README.md

---
projects:
- test
- test2
contexts:
- frrr
howard:
- fool
---
# Orvani Tagger

(From עוֹרְבָנִי, the Hebrew name for th Eurasian Jay)

Platform independent, folder-based, and portable tagging system for organizing and searching files. The command line interface and organizing principles are heavily inspired by the todo.txt standard. 

Every file can be assigned projects, contexts, and tags and have a descriptive note.

Exactly like tasks in todo.txt, files can be categorized by freely defined contexts, defined by the
`@` prefix or projects, defined by the `+` prefix. In addition, the `#` prefix defines hashtags that can be assigned.

So a as an example an audio-file could be assigned to project `+album` and have a context of `@drums` and tagged with `#boombap`, `#lofi`, `#snare`. It's completely up to you how you use the different means of categorization.

## Command Line Tool

### Assigning Contextual Tags

Let's
```
$ orvani add <file/path> [contextual tags ...]
```

Removing contextual tags from a file
```
$ orvani remove <file/path> [contextual tags ...]
```