Skip to main content
Version: 0.1.26

tinct plugins

Manage input and output plugins.

Synopsis

tinct plugins <subcommand> [flags]

Subcommands

CommandDescription
listList all available plugins
searchSearch repositories for plugins
installInstall a plugin from a repository
addAdd an external plugin from a local file, HTTP URL, or Git repo
deleteRemove an external plugin
updateUpdate all external plugins from their sources
syncInstall missing plugins from the lock file
cleanRemove plugins not in the lock file
repo addAdd a plugin repository
repo listList configured repositories
repo deleteRemove a repository
repo updateRefresh repository manifests
repo infoShow repository details

tinct plugins list

Show all available plugins:

tinct plugins list

Output shows:

  • Plugin name and type (input/output)
  • External plugins marked with asterisk (*)
  • Version and description

tinct plugins repo

Manage plugin repositories.

Add a repository

tinct plugins repo add official https://raw.githubusercontent.com/jmylchreest/tinct-plugins/refs/heads/main/repository/repository.json

List repositories

tinct plugins repo list

Remove a repository

tinct plugins repo remove official

Search configured repositories for plugins:

tinct plugins search [query]
FlagDescription
--typeFilter by plugin type (input or output)
--tagFilter by tag (can be repeated)
--authorFilter by author
--repoSearch only in a specific repository

Examples:

tinct plugins search random           # Search for "random"
tinct plugins search --type input # List all input plugins
tinct plugins search --tag terminal # Find terminal-related plugins

tinct plugins install

Install a plugin from a configured repository:

tinct plugins install <plugin-name> [flags]
FlagDefaultDescription
--repositoryInstall from a specific repository
--versionlatestPlugin version to install
-f, --forcefalseForce reinstall if already installed

Examples:

tinct plugins install random                         # Install latest from any repo
tinct plugins install random --repository official # From specific repo
tinct plugins install random --version 0.0.2 # Specific version

The plugin is:

  1. Downloaded from the repository
  2. Verified (checksum)
  3. Installed to ~/.local/share/tinct/plugins/
  4. Registered in ~/.config/tinct/plugins.lock.json

tinct plugins update

Update all external plugins from their original sources:

tinct plugins update

This checks each external plugin for newer versions and downloads updates. Plugins installed from repositories respect version pinning (use --version latest during install to always get the latest).

tinct plugins sync

Install missing plugins from the lock file:

tinct plugins sync [flags]
FlagDescription
-f, --forceForce reinstall all plugins
--verifyVerify checksums of existing plugins
--skip-missingContinue on errors instead of stopping

Useful for restoring plugins on a new machine from a shared plugins.lock.json.

Lock file

Plugin installation data is stored in ~/.config/tinct/plugins.lock.json:

{
"external_plugins": {
"wled": {
"name": "wled",
"path": "/home/user/.local/share/tinct/plugins/wled",
"type": "output",
"version": "0.1.0",
"source": {
"type": "repository",
"repository": "official",
"plugin": "wled",
"version": "0.1.0"
}
}
}
}

Use the --lock-file flag to specify an alternative lock file path.

Plugin paths

External plugins can be loaded from custom paths:

# Use a specific plugin binary
tinct generate -i image -p ~/wallpaper.jpg \
-o my-custom-plugin \
--plugin-path ~/projects/my-plugin/plugin

Examples

Set up official repository

# Add repository
tinct plugins repo add official https://raw.githubusercontent.com/jmylchreest/tinct-plugins/refs/heads/main/repository/repository.json

# Sync plugins
tinct plugins sync

# List available
tinct plugins list

See also