Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Tagstudier

A cli app to extend TagStudio's capacities

This is a alpha app. Tests are inexistents, things move fast and break, make backups of your database file!

Command-Line Help for tagstudier

This document contains the help content for the tagstudier command-line program.

Command Overview:

tagstudier

Tools for TagStudio

Usage: tagstudier [OPTIONS] [COMMAND]

Subcommands:
  • manage-folders — Manage folders based on simple rules
  • merge-tags — Merge two tags together
  • mv — Move a file within the library, while keeping all the metadata attached
Options:
  • -v, --verbose — Increase logging verbosity
  • -q, --quiet — Decrease logging verbosity
  • -l, --library <LIBRARY> — The path to the TagStudio library. If left blank, it will try to find a library folder in the parent folder recursively

tagstudier manage-folders

Manage folders based on simple rules

Usage: tagstudier manage-folders

tagstudier merge-tags

Merge two tags together

Usage: tagstudier merge-tags <TAG_TARGET> [TAGS_TO_MERGE]...

Arguments:
  • <TAG_TARGET> — The tag to merge into
  • <TAGS_TO_MERGE> — The tag(s) to merge into the target

tagstudier mv

Move a file within the library, while keeping all the metadata attached

Usage: tagstudier mv [OPTIONS] <FROM> <TO>

Arguments:
  • <FROM> — The file to move
  • <TO> — Where to move it
Options:
  • -d, --dry — Add this flag to not make changes, and instead print them out

This document was generated automatically by clap-markdown.

Folder configuration

Tagstudier allows for easy management of the folders inside the library. While TagStudio itself doesn't encourage touching the inner files, it has a bunch of use cases still:

  • Lesser strain on the filesystem, making folders open much faster than if you shove everything into a single one
  • Easier organistion when not using TagStudio
  • Allows for synchronizing files to other devices without bringing the whole library

This is done by making "Folder rules". A folder rule apply a specific set of rules that tagstudier will apply. Rules are added in a .TagStudio/TSR_folder_rules.toml file.

Order

Here's the order each rules are processed:

  • Sorting: Each rule is read and applied top to bottom. Any entry moved by a rule cannot be moved by the next ones. This means that folders containing a subset of another one (Ex: Folder "maxwell" being a subset of folder "cat") needs to be before the more general one

Folder rule syntax

NameRequiredFormatDescription
pathYesStringThe path of the folder the rule target
sortingNoStringWhat entries should get sorted in the folder. This is a search string. Any entry that appear in this search sting will be moved to this folder.

Example file

[[folder]]
path = "memes/cat/maxwell"
sorting = "maxwell"

[[folder]]
path = "memes/animals/"
sorting = "(meme cat) or (meme dog)"