Skip to main content
Version: main

tinct plugins

Manage input and output plugins.

Synopsis​

tinct plugins <subcommand> [flags]

Subcommands​

CommandDescription
listList all available plugins
repo addAdd a plugin repository
repo listList configured repositories
repo removeRemove a repository
installInstall an external plugin
syncSync plugins from repositories
enableEnable a plugin
disableDisable a plugin

tinct plugins list​

Show all available plugins with their status:

tinct plugins list

Output shows:

  • Plugin name and type (input/output)
  • Status indicators: Enabled (E), Disabled (D), On-demand (O)
  • External plugins marked with asterisk (*)
  • Version compatibility

Status indicators​

IndicatorMeaning
OOn-demand (loaded when used)
EEnabled (always available)
DDisabled (not loaded)
*External plugin
YCompatible with current tinct
NIncompatible version

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

tinct plugins install​

Install an external plugin from GitHub:

tinct plugins install <github-user>/<repo>

Example:

tinct plugins install jmylchreest/tinct-plugin-wled

The plugin is:

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

tinct plugins sync​

Synchronise plugins from all configured repositories:

tinct plugins sync

This:

  • Fetches repository manifests
  • Updates plugin metadata
  • Reports available updates

tinct plugins enable/disable​

Control which plugins are active:

# Enable a plugin
tinct plugins enable neovim

# Disable a plugin
tinct plugins disable waybar

Configuration is saved to .tinct-plugins.json.

Environment variables​

Override plugin configuration with environment variables:

# Only enable specific plugins
export TINCT_ENABLED_PLUGINS="image,hyprland,kitty"

# Disable specific plugins
export TINCT_DISABLED_PLUGINS="waybar,dunst"

Configuration file​

Plugin settings are stored in .tinct-plugins.json:

{
  "version": "1",
  "enabled_plugins": ["image", "hyprland", "kitty"],
  "disabled_plugins": ["waybar"],
  "external_plugins": {
    "wled": {
      "name": "wled",
      "path": "/home/user/.local/share/tinct/plugins/wled",
      "type": "output",
      "version": "0.1.0"
    }
  }
}

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

Focus on specific plugins​

# Disable plugins you don't use
tinct plugins disable gnome-shell
tinct plugins disable kde-plasma

# Or use environment variable for session
export TINCT_ENABLED_PLUGINS="image,hyprland,kitty,waybar"

See also​