Skip to content
This repository was archived by the owner on Apr 1, 2020. It is now read-only.

Installation Guide

Jump to bottom
Ciarán Mulholland edited this page Feb 15, 2019 · 23 revisions

Installing Oni

NOTE: Windows & macOS releases come with a bundled neovim release, so you do not need a neovim install on those platforms.

Windows

  • Download the Oni installer (x64) for Windows
  • Once it is downloaded, run the installer. This will only take a minute.
  • By default, Oni is installed under C:\Program Files\Oni

There are also other formats available:

You may want to add Oni to your %PATH%, so that from the console, you can open Oni via oni

The default shell for windows is the command prompt. If you have a Linux sub-system installed and want to use bash instead add set shell="bash" to your init.vim.

Alternatively, Oni can be installed via Scoop:

scoop bucket add extras
scoop install oni

In this case, a shim will be added by Scoop that makes the oni command available from the console without having to update the %PATH% variable.

Mac

  • Download Oni for Mac
  • Double-click on the archive to expand
  • Drag Oni.app to the Applications folder

Alternatively, Oni can be installed via Homebrew:

brew update
brew cask install oni

To enable key repeat when pressing & holding a key in Oni, write the following in your terminal:

defaults write com.extropy.oni ApplePressAndHoldEnabled -bool false

You can invoke oni from your terminal after adding it to your PATH, by invoking the Command Menu (CMD-Shift-P) > Add to Path

Linux

Debian and Ubuntu based distributions

If you do not have Neovim, follow the instructions to Install Neovim and ensure the 'nvim' binary is available. Version 0.2.1 or higher is required..

Information on setting the optional ONI_NEOVIM_PATH environment variable can be found here.

  • Download the .deb package (64-bit)
  • Install the package with sudo dpkg -i <file>.deb
  • If dpkg complains (e.g., dpkg: dependency problems...), these will likely be fixed by sudo apt install -f
  • libcanberra-gtk-module warnings are addressed by sudo apt install libcanberra-gtk-module

A tar.gz is also available.

Red Hat based distributions (Fedora, CentOS)

If you do not have Neovim, follow the instructions to Install Neovim and ensure the 'nvim' binary is available. Version 0.2.1 or higher is required..

Information on setting the optional ONI_NEOVIM_PATH environment variable can be found here.

  • Download the .rpm package
  • Install the package with sudo dnf install <file>.rpm

A tar.gz is also available.

Arch based distributions

  • Available via the AUR
  • Install the package with yaourt -S oni

A tar.gz is also available.

Clone this wiki locally