README
¶
RemoteJSON Input Plugin
Type: Input Plugin
Built-in: Yes
Language: Go
Fetch colour palettes from remote JSON APIs with optional JSONPath queries.
Overview
The remotejson plugin fetches colour palettes from HTTP(S) JSON endpoints. It supports JSONPath queries for extracting colours from complex JSON structures and can map source colour names to Tinct's semantic roles.
Features
- ✅ Fetch from any HTTP(S) JSON endpoint
- ✅ JSONPath queries for complex JSON structures
- ✅ Colour format auto-detection (hex, rgb, hsl)
- ✅ Role mapping (map source names to Tinct roles)
- ✅ Configurable timeout
- ✅ Perfect for theme repositories (Catppuccin, Dracula, etc.)
Usage
Basic Fetch
tinct generate -i remote-json \
--remote-json.url "https://example.com/palette.json" \
-o hyprland,kitty
With JSONPath Query
tinct generate -i remote-json \
--remote-json.url "https://api.example.com/themes/dark.json" \
--remote-json.query "$.colours" \
-o hyprland
With Role Mapping
tinct generate -i remote-json \
--remote-json.url "https://example.com/theme.json" \
--remote-json.map "base=background,text=foreground,blue=accent1" \
-o hyprland
CLI Flags
| Flag | Default | Description |
|---|---|---|
--remote-json.url |
(required) | JSON URL to fetch |
--remote-json.query |
(optional) | JSONPath query (e.g., $.colours) |
--remote-json.timeout |
10s |
HTTP request timeout |
--remote-json.map |
{} |
Map source names to roles |
Supported Colour Formats
The plugin auto-detects and parses:
- Hex:
#RRGGBB,RRGGBB,#RGB - RGB:
rgb(R, G, B),{"r": R, "g": G, "b": B} - HSL:
hsl(H, S%, L%)
Examples
Catppuccin Mocha
tinct generate -i remote-json \
--remote-json.url "https://raw.githubusercontent.com/catppuccin/palette/main/palette.json" \
--remote-json.query "$.mocha.colours" \
-o hyprland,kitty
Custom API
tinct generate -i remote-json \
--remote-json.url "https://myapi.com/theme/dark" \
--remote-json.map "bg=background,fg=foreground,primary=accent1" \
-o hyprland
Related
License
MIT License - Same as Tinct
Documentation
¶
Overview ¶
Package remotejson provides an input plugin for fetching colour palettes from remote JSON sources with JSONPath queries.
Index ¶
- type Plugin
- func (p *Plugin) Description() string
- func (p *Plugin) Generate(ctx context.Context, opts input.GenerateOptions) (*colour.Palette, error)
- func (p *Plugin) GetFlagHelp() []input.FlagHelp
- func (p *Plugin) Name() string
- func (p *Plugin) RegisterFlags(cmd *cobra.Command)
- func (p *Plugin) Validate() error
- func (p *Plugin) Version() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Plugin ¶
type Plugin struct {
// contains filtered or unexported fields
}
Plugin implements the input.Plugin interface for remote JSON palette fetching with JSONPath queries.
func (*Plugin) Description ¶
Description returns the plugin description.
func (*Plugin) GetFlagHelp ¶
GetFlagHelp returns help information for all plugin flags.
func (*Plugin) RegisterFlags ¶
RegisterFlags registers plugin-specific flags with the cobra command.
Source Files