spencern / hyperline

✨ Status line plugin for HyperTerm ✨

HyperLine

HyperLine is a status line plugin for Hyper.app. It shows you useful system information such as free memory, uptime and CPU usage. It's designed to be unobtrusive and will match the look of the theme you're currently running.

Install

To install, edit ~/.hyper.js and add "hyperline" to plugins:

plugins: [                                                                                               
  "hyperline",                                                                                           
],   

Configuration

Hyperline shows a collection of information plugins which can be fully configured. By default, all available plugins are displayed in pre-defined colors. You can change which plugins are displayed by editing .hyper.js. Start out with the default config (below), and customize Hyperline to your liking.

• The color string is used to specify the color of the line itself.
• The plugins array determines which plugins are rendered, and in which order.
  • Each plugin configuration has an options object. This can be used to change the color of the each plugin. Some plugins allow you to choose multiple colors.
  • You can omit the options object to stick with the default options for each plugin.
• Check out the list of available colors in the Hyper.app source code.

module.exports = {
  ...
  config: {
    ...
    hyperline: {
      background: 'transparent',
      color: 'black',
      plugins: [
        {
          name: 'hostname',
          options: {
            color: 'lightBlue'
          }
        },
        {
          name: 'ip',
          options: {
            color: 'magenta'
          }
        },
        {
          name: 'memory',
          options: {
            color: 'white'
          }
        },
        {
          name: 'uptime',
          options: {
            color: 'lightYellow'
          }
        },
        {
          name: 'cpu',
          options: {
            colors: {
              high: 'lightRed',
              moderate: 'lightYellow',
              low: 'lightGreen'
            }
          }
        },
        {
          name: 'network',
          options: {
            color: 'lightCyan'
          }
        },
        {
          name: 'battery',
          options: {
            colors: {
              fine: 'lightGreen',
              critical: 'lightRed'
            }
          }
        }
      ]
    }
    ...
  }
  ...
}

Contributing

Feel free to contribute to HyperLine by requesting a feature, submitting a bug or contributing code.

To set up the project for development:

1. Clone this repository into ~/.hyper_plugins/local/
2. Run npm install within the project directory
3. Run npm run build to build the plugin OR npm run dev to build the plugin and watch for file changes.
4. Add the name of the directory to localPlugins in ~/.hyper.js.
5. Reload terminal window

License

MIT