Repository files navigation

The simple but flexible text editor

About -Installation -Quick Start Guide

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

1. 🪶 Is lightweight and efficient
2. 🔧 Can be configured to your heart's content
3. 📦 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.

• 🔌 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
• 🔧 Configure everything including colours, key bindings and behaviours
• 🌔 Write Lua code for configuration
• 🤝 A set-up wizard to make Ox yours from the start

• 🖌️ Syntax highlighting
• ↪️ Undo and redo
• 🔍 Search and replace text
• 📁 Opening multiple files at once
• 👁️ UI that shows you the state of the editor and file
• 🖱️ You can move the cursor and select text with your mouse
• ✍️ Convenient shortcuts when writing code
• ⚔️ Multi-editing features such as multiple cursors and recordable macros
• 🪟 Splits to view multiple documents on the same screen at the same time
• 🗄️ File tree to view, open, create, delete, copy and move files
• ⌨️ Access to terminals within the editor

Become a power user and take advantage of everything on offer.

Found on thewiki page

This will take you step-by-step in great detail through 6 different stages:

1. Installation - advice and how-tos on installation
2. Configuring - changing the layout, adding to and changing the syntax highlighting
3. General Editing - editing a document and controlling the editor
4. Command Line - using the command line interface
5. Plugins - installing or uninstalling community plug-ins and writing or distributing your own plug-ins
6. Roadmap - planned features

To get started, please click on your operating system

• 🐧Linux
• 🪟Windows
• 🍎MacOS

Here are the list of available methods for installing on Linux:

• Manually
• Binary
• Arch Linux
• Fedora
• Debian / Ubuntu

Install one of the following from the AUR:

• ox-bin - install the pre-compiled binary (fastest)
• ox-git - compile from source (best)

You can find an RPM in thereleases page

Install using the following command:

sudo dnf install /path/to/rpm/file

You can find a deb file in thereleases page

Install using the following command:

sudo dpkg -i /path/to/deb/file

Here are the list of available methods for installing on Windows:

• Manually (best)
• Binary

Here are the list of available methods for installing on macOS:

• Manually
• Binary
• Homebrew
• MacPorts

Installox from Homebrew core tap.

brew install ox

On macOS, you can installox viaMacPorts

sudo port selfupdatesudo port install ox

There are precompiled binaries available for all platforms in thereleases page.

• For Linux: download theox executable and copy it to/usr/bin/ox, then runsudo chmod +x /usr/bin/ox
• For MacOS: download theox-macos executable and copy it to/usr/local/bin/ox, then runsudo chmod +x /usr/local/bin/ox
• For Windows: download theox.exe executable and copy it into a location inPATH seethis guide for how to do it

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 forrustup and follow the instructions there for your operating system.

Now with a working version of rust, you can run the command:

cargo install --git https://github.com/curlpipe/ox

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 theox executable will live, althoughrustup will likely do that for you, so no need to worry too much.

Once you have installed Ox, it's time to get started.

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.

Toggle the built-in help message usingCtrl +H. You can pressCtrl +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 usingAlt +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 standardCtrl +S to save it.

You can open files throughCtrl +O - try opening a file!

If you modify it you can then use the standardCtrl +S to update it on the disk, as this file already exists.

When mutltiple files are open, you can navigate back and forth usingAlt +Left andAlt +Right

Once you're done with a file, you can useCtrl +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, clickhere

Now you've exited Ox, let's check out some command line options.

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, clickhere to access the wiki where you will be introduced to all the wide range of features and really make your experience smooth like butter 🧈.

Distributed under the GNU GPLv2 License. SeeLICENSE for more information.

You can contact me on Discord at my handlecurlpipe. I'll be happy to answer any questions you may have!

• Luke (curlpipe), principal developer
• HKalbasi, key contributor
• Spike (spikecodes), for the logo
• The community, for the stars, ideas, suggestions and bug reports

The creators of the following technologies:

• Rust language
• Kaolinite
• Synoptic
• Crossterm
• Mlua
• Jargon-args
• Regex
• Unicode-rs
• Quick-error
• Shellexpand