Home

Welcome to the Ox wiki.

Here you can find the ins and outs of the Ox editor that will help guide you from installation to configuration to writing your own plug-ins to extend the behaviour of the editor.

Where you edit code is one of the most important tools in your toolbelt as a programmer. Ox aims to be equipped with everything you need while not overwhelming the user with hundreds of different niche options.

If you feel any part of this documentation is vague or incorrect, please feel free to open an issue.

Ox Jump Start

Stage 1 - Installation 📦

First things first, it's time to get Ox installed.

Here is the command to install via cargo from source: cargo install --git https://github.com/curlpipe/ox ox

There are other installation methods, click on Installation above to get started.

Stage 2 - Configuration ⚙️

Now Ox is installed, you can access the configuration assistant to help you set up the editor to your preference.

All you need to do is run ox and then answer the questions.

At the end of the set-up, you'll be put into Ox and you can move onto the next stage.

Stage 3 - General Editing 📝

So, now you've opened Ox, and it's been configured to your liking, it's time to start editing.

Ox isn't modal, so you can start typing text straight in with no added steps.

You can use the key binding Ctrl + H to access the built-in help message by default.

Stage 4 - Command Line ⌨️

With Ox installed, it's time to get started. Open your terminal and use the command ox --help to see how you can open Ox.

In short, ox [file path] will open the file, and you can open multiple files via ox [file1] [file2]

Stage 5 - Plugins 🔌

You would have added plug-ins during the set-up process.

You can find more information here about how to use the plug-ins you have installed and more.

You can also find information about writing your own plug-ins to add extra behaviour to the editor.

Stage 6 - Roadmap ⏩

If you're looking for what is in store in future versions, consider looking at the roadmap

If you wish to contribute, add your own feature or fix a particular bug, please feel free to open up an issue / pull request.

Here's to building a powerful tool for the modern programmer 🍻