Open-source productivity booster with a brain
JavaScript CSS Other
Clone or download
Latest commit 56c5ccb May 9, 2018

README.md

Cerebro

Build Status Dependency Status OpenCollective OpenCollective

Usage

You can download the latest version on releases page.

After installation use default shortcut ctrl+space to show an app window. You can customize this shortcut clicking on icon in menu bar → preferences.

Cerebro

Plugins

Core plugins

  • Search in the web with google suggestions;
  • Search & launch application, i.e. spotify;
  • Navigate in file system with file previews (i.e. ~/Dropbox/passport.pdf);
  • Calculator;
  • Smart converter. 15$, 150 рублей в евро, 100 eur in gbp;

Install and manage custom plugins

Use built-in plugins command to search and manage custom plugins.

Discover plugins and more at Cerebro's Awesome List.

Development

If you have any questions feel free to chat in gitter: https://gitter.im/KELiON-cerebro.

Create plugin

Check out plugins documentation.

Install

First, clone the repo via git:

$ git clone https://github.com/KELiON/cerebro.git cerebro

And then install dependencies:

$ cd cerebro && yarn && cd ./app && yarn && cd ../

Run

$ yarn run dev

Note: requires a node version >=6.x

Resolve common issues

  1. AssertionError: Current node version is not supported for development on npm postinstall. After yarn postinstall script checks node version. If you see this error you have to check node and npm version in package.json devEngines section and install proper ones.

  2. Uncaught Error: Module version mismatch. Exepcted 50, got ... This error means that node modules with native extensions build with wrong node version (your local node version != node version, included to electron). To fix this issue run cd ./app && yarn run rebuild

Config file path

Windows: %APPDATA%/Cerebro/config.json

Linux: $XDG_CONFIG_HOME/Cerebro/config.json or ~/.config/Cerebro/config.json

macOS: ~/Library/Application Support/Cerebro/config.json

Package

Use this command to build .app file:

$ yarn run package

Be in touch

Follow to be notified about new releases or learn some productivity tips with Cerebro:

Or subscribe to newsletter to be notified only about big releases.

Support

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

License

MIT © Alexandr Subbotin