Ox is an independent text editor that can be used to write everything from text to code.
Ox is an independent text editor designed for writing everything from plain text to code. It operates in a terminal-based interface, similar to vim, nano, and micro, but it has been built from the ground up with flexibility and customization in mind. While optimized for Linux, Ox supports macOS and Windows as well.
Key Features:
Highly configurable with Lua scripting support
Extensive plugin system for added functionality
Discord Rich Presence integration
Git repository integration
Emmet support for HTML/CSS
Pomodoro timer and todo list tracking
AI-powered code suggestions
Syntax highlighting for multiple languages
Multi-cursor editing and macro recording
File tree navigation with file management capabilities
Built-in terminal access
Audience & Benefit:
Ideal for developers, writers, and anyone in need of a flexible text editor. Ox offers unparalleled customization options, allowing users to tailor the experience to their specific needs while maintaining efficiency and simplicity. Whether you're working on small-scale projects or large codebases, Ox provides the tools necessary to enhance productivity and streamline workflows.
Ox is a text editor that can be used to write everything from text to code.
If you're looking for a text editor that...
:feather: Is lightweight and efficient
:wrench: Can be configured to your heart's content
:package: Has useful features out of the box and a library of plug-ins for everything else
...then Ox is right up your street
It runs in your terminal as a text-user-interface, just like vim, nano and micro, however, it is not based on any existing editors and has been built from the ground up.
It works best on linux, but macOS and Windows are also supported.
Selling Points
Strong configurability
:electric_plug: Plug-In system where you can write your own plug-ins or choose from pre-existing ones
💬 Discord RPC
📗 Git integration
🕸️ Emmet and HTML viewer
⏲️ Pomodoro timer and todo list tracker
🤖 AI code & advice
:wrench: Configure everything including colours, key bindings and behaviours
:moon: Write Lua code for configuration
:handshake: A set-up wizard to make Ox yours from the start
Out of the box features
:paintbrush: Syntax highlighting
:arrow_right_hook: Undo and redo
:mag: Search and replace text
:file_folder: Opening multiple files at once
:eye: UI that shows you the state of the editor and file
:computer_mouse: You can move the cursor and select text with your mouse
:writing_hand: Convenient shortcuts when writing code
There are precompiled binaries available for all platforms in the releases page.
For Linux: download the ox executable and copy it to /usr/bin/ox, then run sudo chmod +x /usr/bin/ox
For MacOS: download the ox-macos executable and copy it to /usr/local/bin/ox, then run sudo chmod +x /usr/local/bin/ox
For Windows: download the ox.exe executable and copy it into a location in PATH see this guide for how to do it
Manual
This is the absolute best way to install Ox, it will ensure you always have the latest version and everything works for your system.
You must have a working installation of the Rust compiler to use this method. Visit the website for rustup and follow the instructions there for your operating system.
Now with a working version of rust, you can run the command:
This will take at worst around 2 minutes. On some more modern systems, it will take around 30 seconds.
Please note that you should add .cargo/bin to your path, which is where the ox executable will live, although rustup will likely do that for you, so no need to worry too much.
Quick Start Guide
Once you have installed Ox, it's time to get started.
Set-Up
You can open Ox using the command
ox
At first, if you don't have a configuration file in place, Ox will walk you through a set-up wizard.
When you've completed it, you should be greeted by ox itself, with an empty, unnamed document.
At the top is your tab line, this shows you files that are open.
At the bottom is your status line, this shows you the state of the editor.
At the far bottom is your feedback line, you'll see information, warnings and errors appear there.
Editing
Toggle the built-in help message using Ctrl + H. You can press Ctrl + H again to hide this message if it gets in the way. This should introduce you to most of the key bindings on offer.
Ox isn't a modal text editor, so you can begin typing straight away. Give it a go! Type in letters and numbers, delete with backspace, indent with tab, break up lines with the enter key.
Move your cursor by clicking, or using the arrow keys. You can also click and drag to select text.
If you modify a file, you may notice a [+] symbol, this means the file open in the editor differs from it's state on the disk. Save the file to update it on the disk and this indicator will disappear.
Because the file we're editing is new and doesn't have a name, you'll need to save as using Alt + S and give it a name.
Now, if you were to edit it again, because it is on the disk and has a name, you can use the standard Ctrl + S to save it.
You can open files through Ctrl + O - try opening a file!
If you modify it you can then use the standard Ctrl + S to update it on the disk, as this file already exists.
When mutltiple files are open, you can navigate back and forth using Alt + Left and Alt + Right
Once you're done with a file, you can use Ctrl + Q to quit out of it.
If all files are closed, Ox will exit.
If you're interested in finding out all the key bindings on offer, click here
Now you've exited Ox, let's check out some command line options.
CLI
You can open files straight from the command line like this:
ox /path/to/file1 /path/to/file2
If you try to open a file that doesn't actually exist, Ox will open it in memory, and as soon as you save, it will save it will create it for you.
See more information regarding command line options using the command.
ox --help
This provides everything you need to know to do some basic editing, but there is so much more you can take advantage of, from plug-ins to opening multiple files on the same screen, to using the built-in terminal and using the file tree to manage your project.
If you are curious in learning more, click here to access the wiki where you will be introduced to all the wide range of features and really make your experience smooth like butter 🧈.
License
Distributed under the GNU GPLv2 License. See LICENSE for more information.
Contact
You can contact me on Discord at my handle curlpipe. I'll be happy to answer any questions you may have!
