Skip to content

Commit 7d9f868

Browse files
committed
updated readme
1 parent e5ad2c5 commit 7d9f868

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Once you've added taglines to your local files you can run `tag`. `tag` will sea
3131
The `tag` help message:
3232

3333
```
34+
Search for local text files with a simple tagging system.
35+
3436
Usage: tag [OPTIONS] <PATH> [QUERY]
3537
3638
Arguments:
@@ -48,10 +50,13 @@ Options:
4850
Disable coloring
4951
-q, --query-stdin
5052
Receive a query from the standard input
53+
-i, --inspect
54+
Enter an interactive inspection mode to view each file individually
5155
-h, --help
5256
Print help
5357
-V, --version
5458
Print version
59+
5560
```
5661

5762
A query contains operators and tags. Usable operators are `&` for the logical AND, `|` for the logical OR and `!` as a unary NOT. Furthermore, you can nest queries by using parantheses. A query could look like this:
@@ -71,3 +76,9 @@ tag "#asdf" . -f "grep 'something' #FILE#" -c "echo 'somethingelse' >> #FILE#"
7176
```
7277

7378
Will only match the files tagged with `#asdf` that also include the string "something". The string "somethingelse" will then be appended to each found file.
79+
80+
### Inspect mode
81+
82+
You can use the inspect mode using `-i`/`--inspect`. In this mode, the content of each file as well as the output of your `-c` command and found tags will be displayed. Keybindings are displayed at the bottom of the screen.
83+
84+
Furthermore, inspect mode supports executing further commands on your files. Those commands are formatted the same way as a command on a file or a filter command.

0 commit comments

Comments
 (0)