Skip to content

README.md

Latest commit

 

History

History
97 lines (87 loc) · 3.34 KB

README.md

File metadata and controls

97 lines (87 loc) · 3.34 KB

Xscriptor Hyper Themes

Theme plugin for Hyper using decorateConfig, with a curated set of palettes aligned with the rest of this repository.

Files

  • index.js: Plugin entry. Implements decorateConfig and selects a theme.
  • themes/*.js: Theme palettes:
    • x
    • madrid
    • lahabana
    • seul
    • miami
    • paris
    • tokio
    • oslo
    • helsinki
    • berlin
    • london
    • praha
    • bogota
  • package.json: Plugin metadata for publishing.
  • install.sh: Installs the plugin locally and enables it in Hyper's config.

Requirements

  • Hyper installed.
  • bash/zsh and sed available to run the installer.

Installation

  • One-liner:
wget -qO- https://raw.githubusercontent.com/xscriptor/terminal/main/hyper/install.sh | bash

or

  • Local install:
cd hyper
chmod +x install.sh && ./install.sh

What the installer does:

  • Detects the correct Hyper config path (macOS, Linux, Windows).
  • Copies index.js, package.json and all themes/*.js to Hyper’s local plugins folder:
    • ~/<App Support>/Hyper/.hyper_plugins/local/hyper-xscriptor-themes
  • Adds localPlugins: ['hyper-xscriptor-themes'] to your .hyper.js.
  • Ensures config: { xscriptorTheme: 'x' } is present.
  • Adds shell aliases with prefix hyperx to ~/.bashrc and ~/.zshrc for fast switching.

Switching Themes

  • In your Hyper config (.hyper.js) set the theme inside the config block:
module.exports = {
  config: {
    xscriptorTheme: 'oslo' // choose any from the list above
  },
  localPlugins: ['hyper-xscriptor-themes']
}
  • Alternatively, set an environment variable before launching Hyper:
export XSCRIPTOR_HYPER_THEME=x-nord

Aliases

  • The installer adds shell aliases to switch quickly:
    • hyperxx, hyperxmadrid, hyperxlahabana, hyperxseul, hyperxmiami, hyperxparis, hyperxtokio, hyperxoslo, hyperxhelsinki, hyperxberlin, hyperxlondon, hyperxpraha, hyperxbogota
  • Usage example:
    • hyperxoslo → writes xscriptorTheme: 'oslo' to your .hyper.js and opens Hyper automatically (CLI or open -a Hyper on macOS).
    • Reload your shell if aliases do not appear: source ~/.bashrc or source ~/.zshrc.

Uninstall

  • Remote one‑liner:
wget -qO- https://raw.githubusercontent.com/xscriptor/terminal/main/hyper/uninstall.sh | bash
# or
curl -fsSL https://raw.githubusercontent.com/xscriptor/terminal/main/hyper/uninstall.sh | bash
  • Local:
chmod +x uninstall.sh && ./uninstall.sh

Notes

  • The plugin uses decorateConfig(config) and merges the selected theme into the user’s config object.
  • Palettes map to Hyper’s ANSI 16 colors consistently across terminals in this repo.
  • If your .hyper.js already has content, the installer appends the plugin safely. Review changes if you keep a heavily customized config.
  • Config locations (per Hyper docs):
    • macOS: ~/Library/Application Support/Hyper/.hyper.js
    • Linux: ~/.config/Hyper/.hyper.js (or $XDG_CONFIG_HOME/Hyper/.hyper.js)
    • Windows: %APPDATA%/Hyper/.hyper.js

Troubleshooting

  • Plugin not loaded:
    • Ensure localPlugins contains hyper-xscriptor-themes. Restart Hyper.
  • Theme not applied:
    • Confirm config.xscriptorTheme is set and matches one of the provided names.
  • Broken config after install:
    • Check .hyper.js syntax. Restore from a backup if needed and re-run the installer.