mirror of https://github.com/mickael-menu/zk
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
28 lines
1.0 KiB
Markdown
28 lines
1.0 KiB
Markdown
# Tags
|
|
|
|
Tags are a useful way to organize and filter your notes with `zk`, which supports most syntaxes:
|
|
|
|
* `#hashtags`
|
|
* `:colon:separated:tags:` ([opt-in](note-format.md))
|
|
* Bear's `#multi-word tags#` ([opt-in](note-format.md))
|
|
* YAML frontmatter (`tags` and `keywords` keys).
|
|
|
|
You can filter your notes by their tags using the `--tags` option, as demonstrated in [Searching and filtering notes](note-filtering.md).
|
|
|
|
```sh
|
|
$ zk list --tag "inbox OR todo, NOT done"
|
|
```
|
|
|
|
## Listing tags
|
|
|
|
You can list all the tags found in your notebook using `zk tag list`.
|
|
|
|
The following variables are available in the templates used when formatting tags, for example with `zk tag list --format <template>`.
|
|
|
|
| Variable | Type | Description |
|
|
|--------------|--------|------------------------------------------------|
|
|
| `id` | int | Unique ID of this tag in the Notebook database |
|
|
| `name` | string | Name of the tag |
|
|
| `note-count` | int | Number of notes attached to this tag |
|
|
|