hyperline

    1.2.0 • Public • Published

    HyperLine

    HyperLine is a status line plugin for Hyper.app. It shows you useful system information such as free memory, uptime and CPU usage.

    Screenshot

    Install

    • NOTE: HyperLine is not currently supported when using Microsoft Windows. See this issue for additional information.

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

    plugins: [
      "hyperline",
    ],
    

    Styling the line

    We implemented the same mechanism for styling/creating css classes that Hyper uses. This will allow you to create custom HyperLine themes the same way you would create a Hyper css theme.

    Configuring plugins

    Add the names of plugins in the order in which you would like them to be displayed to your ~/.hyper.js:

    config: {                                                                      
      hyperline: {                                                                 
        plugins: [                                                                 
          "ip",                                                                    
          "cpu",                                                                   
          "spotify"                                                                
        ]                                                                          
      },
    }
    

    You can see a list of all available plugins in src/lib/plugins/index.js

    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

    Authors

    Contributors

    This project exists thanks to all the people who contribute.

    Install

    npm i hyperline

    DownloadsWeekly Downloads

    243

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    65.3 kB

    Total Files

    4

    Last publish

    Collaborators

    • nicktikhonov
    • timneutkens