bhanditz / oni

Oni: An IDE powered by Neovim

IDE powered by Neovim + React + Electron

• Introduction
• Features
• Installation
  • Windows
  • Mac
  • Linux
• Documentation
• Contributing
• Acknowledgements
• License

Introduction

Oni is a neovim front-end UI with rich IDE-like UI integration points, drawing inspiration from VSCode, Atom, and LightTable.

This repository is under active development, and until 1.0 please consider everything unstable.

Check out Releases for the latest binaries, or Build Oni from source. Consider making a donation via BountySource if you find this project useful!

Features

Oni brings several IDE-like integrations to neovim:

• Quick Info
• Code Completion
• Syntax / Compilation Errors
• Fuzzy Finding
• Status Bar

Oni is cross-platform and supports Windows, OS X, and Linux.

Installation

• Check out Releases for the latest binary.
• If you'd prefer to build from source, see Development

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

Windows

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

You can also find install via a zip archive

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

Mac

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

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 is required..

• Download the .deb package (64-bit)
• Install the package with sudo dpkg -i <file>.deb

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 is required..

• 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.

Goals

The goal of this project is to provide both the full-fledged Vim experience, with no compromises, while pushing forward to enable new scenarios.

• Modern UX - The Vim experience should not be compromised with poor user experiences that stem from terminal limitations.
• Rich plugin development - using JavaScript, instead of VimL, allowing deep-language integration.
• Cross-platform support - across Windows, OS X, and Linux.
• Batteries included - rich features are available out of the box - minimal setup needed to be productive. TypeScript development is the canonical example, but the hope is that other language providers will be included. Later, an included package manager will make it simple to find and install plugins.
• Performance - no compromises, Vim is fast, and Oni should be fast too.
• Ease Learning Curve - without sacrificing the Vim experience

Vim is an incredible tool for manipulating text at the speed of thought. With a composable, modal command language, it is no wonder that Vim usage is still prevalent today even in the realm of modern editors.

However, going from thought to code has some different challenges than going from thought to text. IDEs today provide several benefits that help to reduce cognitive load when writing code, and that benefit is tremendously important - not only in terms of pure coding efficiency and productivity, but also in making the process of writing code enjoyable and fun.

The goal of this project is to give an editor that gives the best of both worlds - the power, speed, and flexibility of using Vim for manipulating text, as well as the rich tooling that comes with an IDE.

Documentation

• Check out the Wiki for documentation on how to use and modify Oni.
• FAQ
• Roadmap

Contributing

There many ways to contribute to Oni:

• Support Oni financially by making a donation via Bountysource
• Submit bugs or propose new features.
• Review and and upate our documentation
• Try out the latest released build
• Contribute a bug fix or code change - start by checking our Debugging Page

Acknowledgements

Oni is an independent project and is made possible by the support of some exceptional people. Big thanks to the following people for helping to realize this project:

• the neovim team, especially justinmk and tarruda - Oni would not be possible without their vision
• jordwalke for his generous support, inspiration, and ideas. And React ;)
• keforbes for helping to get this project off the ground
• tillarnold for giving us the oni npm package name
• mhartington for his generous support
• badosu for his support, contributions, and managing the AUR releases
• All our current monthly sponsors and backers
• All of our contributors - thanks for helping to improve this project!

Several other great neovim front-end UIs here served as a reference, especially NyaoVim and VimR. I encourage you to check those out!

Thank you!

License

MIT License. Copyright (c) Bryan Phelps

Windows and OSX have a bundled version of Neovim, which is covered under Neovim's license

Bundled Plugins

Bundled plugins have their own license terms. These include:

• typescript-vim (oni/vim/core/typescript.vim)
• targets.vim (oni/vim/default/bundle/targets.vim)
• vim-commentary (oni/vim/default/bundle/vim-commentary)
• vim-unimpaired (oni/vim/default/bundle/vim-unimpaired)
• vim-reasonml (.vim files in oni/vim/core/oni-plugin-reasonml)