SilkCircuit

Appearance

Health Check ​

Diagnostics and troubleshooting for SilkCircuit.

Running Health Check ​

vim
:checkhealth silkcircuit

This command verifies your SilkCircuit installation and configuration.

Check Categories ​

The report is grouped into six sections. A full transcript is at the bottom of this page.

SilkCircuit ​

Reports the running Neovim version (0.10.0 or later is required), whether termguicolors is on, and whether SilkCircuit is the active colorscheme. A missing termguicolors is an error, since every highlight the theme sets is a 24-bit color.

If true colors aren't working:

  1. Add vim.opt.termguicolors = true to your config
  2. Verify your terminal supports true colors
  3. Check the $COLORTERM environment variable

Configuration ​

Echoes the four settings that change what gets painted: the active variant, transparent, terminal_colors, and dim_inactive.

Plugin integrations ​

Reports how many integrations the theme ships, how many of their plugins it can see on your runtime path, and which ones those are. Detection is for this report only and never gates loading, so an integration you have not installed still has its highlights defined. Any integration you switched off in setup() is listed as a warning.

User preferences ​

Shows the saved variant and glow setting if ~/.local/share/nvim/silkcircuit_preferences.json exists, and says so plainly when it doesn't.

WCAG contrast ​

Measures every distinct text color in the active variant against that variant's own background and reports how many clear WCAG AA at 4.5:1. Anything short of the ratio is listed individually as a warning or an error.

Commands ​

Lists the commands the plugin registered, as a reminder of what is available.

Common Issues ​

Theme Not Loading ​

Symptoms:

  • Colors look wrong
  • Default Neovim colors showing

Solutions:

  1. Verify installation:
vim
:Lazy
" Check SilkCircuit is installed
  1. Load colorscheme:
lua
vim.cmd.colorscheme("silkcircuit")
  1. Check for errors:
vim
:messages

Wrong Colors ​

Symptoms:

  • Colors appear washed out
  • Colors don't match screenshots

Solutions:

  1. Enable true colors:
lua
vim.opt.termguicolors = true
  1. Check terminal settings:
bash
echo $COLORTERM
# Should show "truecolor"
  1. Try a different terminal emulator

Slow Loading ​

Symptoms:

  • Visible delay on startup that goes away when the colorscheme is disabled

Solutions:

  1. Measure it. Set vim.g.silkcircuit_debug = true and restart; the theme prints its own load time, which is about 5ms on a laptop.
  2. If the number is far higher, another plugin is probably reloading the colorscheme repeatedly. Check :autocmd ColorScheme.
  3. Open an issue with the measured time and your plugin list.

Plugin Not Themed ​

Symptoms:

  • Specific plugin uses wrong colors
  • Plugin highlights don't match

Solutions:

  1. Check if plugin is supported:
vim
:SilkCircuitIntegrations
  1. Verify plugin is loaded before theme:
lua
-- In lazy.nvim, set priority
{
  "hyperb1iss/silkcircuit",
  priority = 1000,
  lazy = false,
}
  1. Report missing integrations on GitHub

Contrast Issues ​

Symptoms:

  • Text hard to read
  • Health check shows contrast warnings

Solutions:

  1. Try a different variant:
vim
:SilkCircuit glow  " Maximum contrast
:SilkCircuit soft  " Gentler contrast
  1. Override specific highlights:
lua
require("silkcircuit").setup({
  on_highlights = function(hl, colors)
    hl.Comment = { fg = "#888888" }  -- Lighter comments
  end,
})

Debug Mode ​

Enable debug logging:

lua
vim.g.silkcircuit_debug = true

View debug output:

vim
:messages

Getting Help ​

  1. Run :checkhealth silkcircuit
  2. Check the GitHub Issues
  3. Include health check output in bug reports

Health Check Output Example ​

silkcircuit: require("silkcircuit.health").check()

SilkCircuit
- OK Neovim 0.12.5
- OK termguicolors is enabled
- OK SilkCircuit is the active colorscheme

Configuration
- OK Variant: neon
- OK Transparent: false
- OK Terminal colors: true
- OK Dim inactive: false

Plugin integrations
- OK 39 integrations available, 5 plugins detected
- OK Detected: cmp, gitsigns, lualine, telescope, treesitter

User preferences
- OK No saved preferences, using the configured values

WCAG contrast
- OK Checked 19 distinct text colors against the 'neon' background (#12101a)
- OK All 19 meet WCAG AA (4.5:1)

Commands
- OK :SilkCircuit [neon|vibrant|soft|glow|dawn] - switch variant
- OK :SilkCircuitGlow [on|off|toggle] - control glow mode
- OK :SilkCircuitContrast - check WCAG contrast
- OK :SilkCircuitIntegrations - show integration status
- OK :help |silkcircuit| - documentation