https://github.com/vifon/tmsu.el
An integration between GNU Emacs and TMSU
https://github.com/vifon/tmsu.el
dired emacs tagging tmsu
Last synced: 3 months ago
JSON representation
An integration between GNU Emacs and TMSU
- Host: GitHub
- URL: https://github.com/vifon/tmsu.el
- Owner: vifon
- License: gpl-3.0
- Created: 2023-01-01T17:58:39.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-30T22:10:41.000Z (5 months ago)
- Last Synced: 2024-12-30T23:18:40.160Z (5 months ago)
- Topics: dired, emacs, tagging, tmsu
- Language: Emacs Lisp
- Homepage:
- Size: 76.2 KB
- Stars: 19
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
tmsu.el
=======
An integration between GNU Emacs and [TMSU](https://tmsu.org/).
FEATURES
--------
`tmsu.el` doesn't try to replicate the full functionality of TMSU.
Instead it focuses on enhancing the UX of the most common operations:
tag editing and querying. It's primarily intended to be used from
`dired`, though `tmsu-edit` can be used separately from it.
The two main commands are `tmsu-dired-edit` to interactively edit the
tag list of the currently selected file and `tmsu-dired-query` to
create a `dired` buffer with the TMSU query results. Both utilize the
Emacs `completing-read-multiple` interface and so greatly benefit from
packages such as `vertico`.
### Persistent queries
The queries can be stored for later recall either with the
[native Emacs bookmarks][1] or with `org-mode` links using
[org-store-link][2].
[1]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Bookmarks.html
[2]: https://orgmode.org/manual/Handling-Links.html
The first type is supported out of the box. The second one needs to be loaded:
```elisp
(require 'ol-tmsu)
```
### Bulk operations
`tmsu-dired-tags-add` and `tmsu-dired-tags-remove` can be used to edit
tags of multiple files at a time. For convenience, the completion of
`tmsu-dired-tags-remove` offers the sum of tags of all the
marked files.
INSTALLATION
------------
To install `tmsu.el`, you can use the following code:
```elisp
(use-package tmsu
:ensure t
:after dired
:bind (:map dired-mode-map
(";" . tmsu-dired-edit)
("M-;" . tmsu-dired-query)
("C-M-;". tmsu-dired-overlay))
:config (require 'tmsu-dired))
```
If you prefer to attach your TMSU tags to directories and not single
files (think: a directory with a set of movies with common tags), use
`tmsu-dired-edit-directory` instead of `tmsu-dired-edit`. See their
docstrings for the details.
For the `org-mode` links support, this is the suggested setup:
```elisp
(use-package ol-tmsu
:ensure t
:after (:any org tmsu-dired)
:if (executable-find "tmsu"))
```
**Orderless compatibility**
If you're using [Orderless](https://github.com/oantolin/orderless)
with a style dispatcher using `=` as a suffix (which is the default
since early 2023 when `orderless-affix-dispatch` got added), you may
want to add the following snippet:
```elisp
(defun call-without-orderless-dispatchers (orig &rest args)
"Use with `advice-add' (`:around') to ignore the dispatchers."
(let ((orderless-style-dispatchers nil))
(apply orig args)))
(advice-add 'tmsu-edit :around
#'call-without-orderless-dispatchers)
(advice-add 'tmsu-dired-query :around
#'call-without-orderless-dispatchers)
```
This modification allows the completion suggestions for inputs like
`tag=` to show up immediately and not only after the next keypress
(that makes the input not end with `=` anymore).