ljcucc / tagspaces-cli

A CLI version of TagSpaces that compatible with official one.

TagSpaces CLI 🏷️

TagSpaces is great, but how about the terminal users? now there's the new tool for you! the Tagspaces CLI. which compatible with the official sidecar format.

What is sidecar ?

sidecar is one of method that TagSpaces using, which are json files inside .ts folder to record tags you add for the files. find more info at official documentation

How to use?

Installation

Adding tags script into your $PATH, then that it! currently support python, I'll build more version for that. or you are lazy to type command, here you go:

# bash
echo export "PATH=\$PATH":"$(pwd)/" >> ~/.bashrc

# zsh
echo export "PATH=\$PATH":"$(pwd)/" >> ~/.zshrc

Listing

Listing tags of files and tags in folder by using:

tags list
# or (l) for abbr
tags l

Listing tags and remember it to global environment:

tags list --save
# or (-s) for abbr
tags l -s

Then using --global or -g to list all remembered tags in global environment:

tags list --global
# or (-g) for abbr
tags l -g

Adding

Adding new tag to file by using:

# (👇) will auto open an terminal UI to select file and tags
tags add

# (👇)  or ... (are the same)
tags new
tags n

With --file [path2file] tag you can add tag to file accurately without terminal UI:

# or using -f, --path or -p for --file instead
tags n -f ./README.md
tags n --path ./README.md
tags n -p ./README.md

Screenshots

QnA

Why only using sidecar ?

Because sidecar dose not effect the origin file name, while the file name become your relativity of everything, like README.md or some file links. sidecar by the other hand, that using json file to manage tags, which dose not effect the origin relativity. If you dont want to use sidecar method, then you may not need this tool for tagSpaces.

Why using python3?

Becuase every morden operating system (like linux or macOS) have python3 preinstalled, so Python3 become the better options to build this tools. About the "Windows" side, althrough Python3 is no preinstalled, but you can use docker or WSL to run this script as well.

More information

look forward on Official documentation!