silkcircuit
# ๐โก SilkCircuit: Electric Meets Elegant <div align="center"> [](https://github.com/hyperb1iss/silkcircuit) [](https://www.w3.org/WAI/WCAG21/quickref/) [](https://opensource.org/licenses/MIT) [](https://neovim.io/) [](https://marketplace.visualstudio.com/items?itemName=hyperb1iss.silkcircuit-theme) [](https://chromewebstore.google.com/) ๐ _A vibrant cyberpunk color system for your entire dev environment._ ๐ [โก Quick Start](#-quick-start) ยท [๐ Neovim](#-neovim) ยท [๐จ Variants](#-variants) ยท [๐ Full Ecosystem](#-full-ecosystem) </div> <div align="center"> <img src="assets/silkcircuit-lockup-banner.png" alt="SilkCircuit" width="80%"> </div> <br> <div align="center"> <img src="assets/screenshots/nvim-neotree.png" alt="SilkCircuit in Neovim with Neo-tree" width="90%"> </div> ## ๐ญ What Is SilkCircuit? One palette, one semantic system, five intensity variants, every tool in your workflow. SilkCircuit themes editors, terminals, browsers, system monitors, and CLI tools with consistent colors and WCAG AA contrast ratios across the board. ### ๐ Platforms | Category | Targets | | ---------------- | ------------------------------------------------------------------ | | ๐ป **Editors** | Neovim (40+ plugin integrations), VS Code (Marketplace), AstroNvim | | ๐ฅ๏ธ **Terminals** | Ghostty, Kitty, Alacritty, Warp, Windows Terminal | | ๐ **Browsers** | Chrome (Web Store, 5 variants + DevTools CSS) | | ๐ง **CLI Tools** | btop, K9s, lazygit, bat, fzf, lsd, procs, atuin, Starship | | โ๏ธ **System** | COSMIC Desktop, fastfetch, dmesg, tmux | | ๐ฏ **Other** | Git (delta integration), Slack, Lualine | ### ๐๏ธ Variants Five intensity levels, all using the same underlying palette: | Variant | Style | Best For | | -------------- | --------------------------- | ---------------------- | | โก **Neon** | 100% saturated | Maximum vibrancy | | ๐ฎ **Vibrant** | 85% intensity | Balanced energy | | ๐ธ **Soft** | 70% intensity | Extended sessions | | ๐ **Glow** | Ultra-dark bg, pure neon fg | Low-light / OLED | | ๐ **Dawn** | Light theme | Daytime & bright rooms | ## ๐ช Quick Start ### โก Universal Installer The fastest way to theme everything at once. Detects your installed tools and applies matching SilkCircuit configs with backups: ```bash git clone https://github.com/hyperb1iss/silkcircuit.git cd silkcircuit ./install.sh ``` ### ๐ฏ Individual Platforms Pick what you need: <details open> <summary><b>๐ฎ Neovim</b> (lazy.nvim)</summary> ```lua { "hyperb1iss/silkcircuit", lazy = false, priority = 1000, config = function() vim.cmd.colorscheme("silkcircuit") end, } ``` </details> <details> <summary><b>๐ฆ Neovim</b> (packer.nvim)</summary> ```lua use { "hyperb1iss/silkcircuit", config = function() vim.cmd("colorscheme silkcircuit") end } ``` </details> <details> <summary><b>๐ Neovim</b> (vim-plug)</summary> ```vim Plug 'hyperb1iss/silkcircuit' colorscheme silkcircuit ``` </details> <details> <summary><b>๐ VS Code</b></summary> Install from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=hyperb1iss.silkcircuit-theme), or: ```bash code --install-extension hyperb1iss.silkcircuit-theme ``` </details> <details> <summary><b>๐ Chrome</b></summary> Available on the Chrome Web Store (all 5 variants), or load unpacked: ```bash make chrome # chrome://extensions/ โ Developer mode โ Load unpacked # Select: extras/chrome-theme/silkcircuit-{variant}/ ``` </details> <details> <summary><b>๐ฅ๏ธ Terminals</b></summary> ```bash # Ghostty: copy variant config to ~/.config/ghostty/ cp extras/ghostty/silkcircuit-neon ~/.config/ghostty/themes/ # Kitty cp extras/kitty.conf ~/.config/kitty/themes/silkcircuit.conf # Alacritty cp extras/alacritty.yml ~/.config/alacritty/themes/silkcircuit.yml # Warp cp extras/warp.yaml ~/.warp/themes/silkcircuit.yaml # Windows Terminal: import extras/windows-terminal.json in settings ``` </details> <details> <summary><b>๐ง CLI Tools</b></summary> ```bash # btop (5 variants) cp extras/btop/silkcircuit_*.theme ~/.config/btop/themes/ # K9s (5 variants) cp extras/k9s/silkcircuit_*.yaml ~/.config/k9s/skins/ # Git colors with delta integration cat extras/gitconfig >> ~/.gitconfig # fzf source extras/fzf.sh # or add to .zshrc/.bashrc # Starship prompt cp extras/starship/silkcircuit.toml ~/.config/starship.toml ``` </details> ## ๐ Neovim The Neovim theme is the most feature-rich target: bytecode-compiled for <5ms load times, 40+ auto-detected plugin integrations, and persistent preferences. <div align="center"> <img src="assets/screenshots/nvim-telescope.png" alt="Telescope integration" width="85%"> </div> ### ๐ช Configuration ```lua require("silkcircuit").setup({ transparent = false, terminal_colors = true, dim_inactive = false, variant = "neon", -- "neon" | "vibrant" | "soft" | "glow" | "dawn" styles = { comments = { italic = true }, keywords = { bold = true }, functions = { bold = true, italic = true }, variables = {}, strings = { italic = true }, }, integrations = { telescope = true, -- all auto-detected by default neotree = true, notify = true, cmp = true, mini = true, }, }) ``` ### ๐ฎ Plugin Support All integrations activate automatically when plugins are detected. - ๐ฏ **Core**: Telescope, Neo-tree, LSP, Treesitter, nvim-cmp, Mason - ๐ **Navigation**: Flash, Harpoon, Which-Key, Mini.jump - ๐ง **Git & Dev**: Gitsigns, Neogit, DAP - ๐ **UI**: Lualine, BufferLine, Notify, Noice, Alpha, Indent Blankline, Rainbow Delimiters ### ๐ธ AstroNvim ```lua return { "AstroNvim/astrocommunity", { "hyperb1iss/silkcircuit", name = "silkcircuit" }, } ``` ### ๐ฎ Commands | Command | Description | | -------------------------- | -------------------------------------------- | | `:SilkCircuit {variant}` | Switch variant (neon/vibrant/soft/glow/dawn) | | `:SilkCircuitContrast` | Check WCAG contrast compliance | | `:SilkCircuitCompile` | Compile theme for performance | | `:SilkCircuitIntegrations` | Show detected plugin integrations | | `:checkhealth silkcircuit` | Run diagnostics | ## ๐ Full Ecosystem SilkCircuit extends far beyond your editor. See [extras/README.md](extras/README.md) for setup instructions for every supported tool. ### ๐จ Color Palette | Color | Hex | Usage | | ------------------ | --------- | ---------------------------------------------------------------------------------- | | Background | `#0a0a0f` |  | | Foreground | `#e0e0e0` |  | | ๐ Electric Purple | `#e135ff` |  Keywords, primary accents | | ๐ธ Hot Pink | `#ff79c6` |  Strings, secondary | | ๐ Neon Cyan | `#80ffea` |  Functions, links | | โ Success Green | `#50fa7b` |  Success states | | โก Electric Yellow | `#f1fa8c` |  Warnings, variables | | ๐ฅ Warm Orange | `#ffb86c` |  Numbers, constants | ## ๐ธ Screenshot Gallery <details open> <summary><b>Neovim</b></summary> <br> | Syntax Highlighting | Theme Highlights | | :-----------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------: | | <img src="assets/screenshots/nvim-lua.png" alt="Lua syntax highlighting" width="400"> | <img src="assets/screenshots/nvim-theme-highlights.png" alt="Theme highlight groups" width="400"> | </details> <details open> <summary><b>Terminal & CLI Tools</b></summary> <br> | lazygit | btop | | :------------------------------------------------------------------: | :---------------------------------------------------------------------------: | | <img src="assets/screenshots/lazygit.png" alt="lazygit" width="400"> | <img src="assets/screenshots/btop.png" alt="btop system monitor" width="400"> | | bat | fzf | | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------: | | <img src="assets/screenshots/bat.png" alt="bat syntax viewer" width="400"> | <img src="assets/screenshots/fzf.png" alt="fzf with bat preview" width="400"> | | git log | delta | | :------------------------------------------------------------------: | :--------------------------------------------------------------------------: | | <img src="assets/screenshots/git-log.png" alt="git log" width="400"> | <img src="assets/screenshots/delta.png" alt="delta diff viewer" width="400"> | | lsd | procs | | :----------------------------------------------------------------------------: | :-----------------------------------------------------------------------------: | | <img src="assets/screenshots/lsd.png" alt="lsd directory listing" width="400"> | <img src="assets/screenshots/procs.png" alt="procs process viewer" width="400"> | | fastfetch | | :----------------------------------------------------------------------------------: | | <img src="assets/screenshots/fastfetch.png" alt="fastfetch system info" width="400"> | </details> ## ๐ ๏ธ Troubleshooting **๐ค Neovim theme not loading?** Requires Neovim 0.8.0+ with `vim.opt.termguicolors = true`. Run `:checkhealth silkcircuit`. **๐ญ Colors look wrong?** Your terminal must support true colors (24-bit). Try a different terminal emulator if unsure. **๐๏ธ Performance issues?** Run `:SilkCircuitCompile` to regenerate the bytecode cache. **๐ญ Need help?** [Open an issue](https://github.com/hyperb1iss/silkcircuit/issues) with your config and error output. ## ๐ Contributing ```bash git clone https://github.com/hyperb1iss/silkcircuit.git cd silkcircuit make setup # install dev dependencies make test # run unit tests make lint # check code quality ``` See [STYLE_GUIDE.md](STYLE_GUIDE.md) for the entire SilkCircuit design language. ## ๐ License MIT License. See [LICENSE](LICENSE) for details. --- <div align="center"> If you love SilkCircuit, [buy me a Monster Ultra Violet โก](https://ko-fi.com/hyperb1iss) โฆ Built with obsession by <a href="https://hyperbliss.tech"><strong>Hyperbliss Technologies</strong></a> โฆ </div>