ash-editor 0.1.0.dev14
A modern terminal text-editor
License: MIT
Keywords: terminal text-editor

![ash logo](https://github.com/akashnag/ash/raw/master/assets/banner.png)

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/akashnag/ash/blob/master/LICENSE.md) ![Downloads](https://img.shields.io/github/downloads/akashnag/ash/total) ![Size](https://img.shields.io/github/size/akashnag/ash/dist/ash-editor-0.1.0.dev13.tar.gz) ![SLOC](https://sloc.xyz/github/akashnag/ash)

**ash** is a simple and clean terminal-based text editor, that aims to be easy to use with modern key-bindings. It is capable of handling multiple files simultaneously and has a wide array of modern features. Here is a picture of **ash** editing this README file:

![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ash-default.png)

**ash** is written in Python 3.8 using the curses library. View this project on GitHub: [ash on GitHub](https://github.com/akashnag/ash)

## Table of Contents

- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
  - [Prerequisites](#prerequisites)
  - [Installing **ash**](#installing-ash)
  - [Uninstalling **ash**](#uninstalling-ash)
- [Colors](#colors)
- [Usage](#usage)
- [Key Bindings](#key-bindings)
- [Contributing](#contributing)
- [Screenshots](#screenshots)
- [License](#license)

- - -

**Note: The latest version is always the nightly build that can be downloaded from the ash [website](https://akashnag.github.io/ash), and the information presented here always refers to that build only. Unless you have any specific reason not to, you should always download the nightly build to get the latest features/updates/bug-fixes.**

## Features

The following is a list of features available in **ash**:

- Easy to use, clean and intuitive interface
- Common key bindings (Help on F1, Arrow keys for movement, Shift+Arrow/Home/End/PgUp/PgDown for selecting text, cut/copy/paste using Ctrl+X/C/V, undo/redo using Ctrl+Z/Y, find/replace/goto using Ctrl+F/H/G, etc.) and support for remapping key bindings to your taste
- Common editor features such as undo/redo, line numbers, find-replace, cut-copy-paste, etc.
- True support for wrapping (both hard & soft) with intuitive cursor movements along wrapped text
- Multi-file editing with support for windows and tabs
- Auto-backup
- Support for Unicode
- Project mode (opening a directory instead of individual files)
- Complete session (for projects) and undo persistence (turned on for projects opened directly from command-line)
- Live search
- Support for search/replace in **all** open files
- Support for searching using regular expressions
- Auto-indentation, Select+Tab/Shift-Tab to increase/decrease indent
- Auto insertion of matching braces/quotes and auto-enclosure when text is selected and braces/quotes are typed
- Support for unlimited splits per tab (subject to screen size) and support for unlimited tabs
- Support for various text-encodings
- Checks (live) and reloads (if user permits) files which have been modified externally
- Selection highlighting (highlights text under selection wherever they occur in the document)
- Color scheme customization
- View list of recent files, view project explorer (in project mode)
- Syntax highlighting (limited)
- Git integration (shows untracked, modified files, etc.)
- Multiple Cursors
- Command palette
- Basic mouse support
- Open terminal / execute shell commands
- Limited IDE features like compile, build, execute...
- Supports project/folder specific settings along with global settings

## Requirements

1. You need a resolution of at least 102 x 22 in your terminal emulator
1. Your terminal must support Unicode and be able to display at least 256 colors with the capability of remapping color palettes (Works best on: `xterm-256`). Monochrome terminals are also partially supported.
1. If you are running the source distribution, you need the GNU C compiler collection besides Python 3.8, as some parts of the application are written in Cython. The first time you run the application, Cython will compile and build the `*.pyx` files, which may increase load time (Ignore the warnings during compilation)

**ash is primarily targetted to Linux. This version of ash has only been tested on Ubuntu 20.04 with Python 3.8.2 (64-bit)**

## Installation

*Note: Instructions provided here are for Debian/Ubuntu based systems. For your distribution, you may need to issue different instructions to install the necessary packages.*

### Prerequisites

You need certain packages and Python 3 itself to run **ash** on your system, as there are no prebuilt binaries available yet.

```bash
$ sudo apt install git
$ sudo apt install xclip
$ sudo apt install python3
$ sudo apt install python3-pip
```

Depending on your system, you may also need to install the following packages:

```bash
$ sudo apt install python3-devel
```

### Installing ash

**Note: To get the latest updates and bug-fixes, download the latest nightly build from the [Website](https://akashnag.github.io/ash)**

```bash
$ sudo pip3 install ash-editor
```

To run **ash** make sure you have `:$HOME/.local/bin` appended to your $PATH variable in the file `~/.bashrc`. To execute **ash**, see the [Usage](#usage) section.

### Uninstalling ash

To uninstall **ash** you can use:

```bash
$ sudo pip3 uninstall ash-editor
```

## Colors

If you are using the default Ubuntu terminal, to enable 256 make sure your `TERM` variable is set to `xterm-256color`. After **ash** runs for the first time, it creates a `default.json` JSON file inside the ~/.ash-editor/themes directory. You can edit that file directly to change how **ash** looks on your system. The RGB triplets listed in that file range from 0--255. If you want to reset **ash** to its default colors, delete the configuration file using: `rm ~/.ash-editor/themes/default.json`. The theme file defines the color names first followed by setting the foreground and the background colors of each GUI element of the app.

## Usage

Once you have downloaded **ash**, and set it up as detailed above, you are ready to use it. 

**NOTES:**
1. If you have not updated your path variable, you must specify the full path to the ash binary.
1. Your terminal resolution should be at least 102 (width) x 22 (height). Opening the editor in a lower resolution may unexpectedly crash the application. This requirement is necessary to properly display the dialog-boxes.
1. It will take a while to start up **ash** for the first time, this is normal. From the second time onwards, it should start up faster.

To run **ash**:

```bash
$ ash path/to/file.txt
```

or, to open an empty buffer:

```bash
$ ash
```

or, to open a project (directory):

```bash
$ ash path/to/directory
```

## Key Bindings

See the [Key Bindings](https://github.com/akashnag/ash/blob/master/KEYBINDINGS.md)

## Contributing

### Contributing to the source code

If you find any bugs, please report them. I am also happy to accept pull requests from anyone for either bug-fixes, performance improvements, or for implementing the not-yet-implemented features listed above. Please consider contributing towards new features **only when** the features listed above have been fully implemented. For more information visit the project's Github page: [ash on GitHub](https://github.com/akashnag/ash)

### Bug-fixes and feature enhancements

You can use the [GitHub issue tracker](https://github.com/akashnag/ash/issues) to report bugs, ask questions, or suggest new features.

### Discussions

For discussions related to the development roadmap and the **ash** editor in general, you can join the [ash Discord Server](https://discord.gg/KErp57T6en).

### Say Thanks\!

If you are not into software development, you can still contribute financially. Financial contributions help me prioritize working on this project over others and helps me know that there is a real demand for this software.

<a href="https://www.buymeacoffee.com/nagakash"><p align="center"><img src="https://github.com/akashnag/ash/raw/master/assets/bmc-button.png" height="70"/></p></a>


## Screenshots

![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss1.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss2.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss3.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss4.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss5.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss6.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss7.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss8.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss9.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss10.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss11.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss12.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss13.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss14.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss15.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss16.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss17.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss18.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss19.png)
![Screenshot](https://github.com/akashnag/ash/raw/master/assets/ss20.png)


## License

Copyright &copy; Akash Nag. All rights reserved.

Licensed under the [MIT](https://github.com/akashnag/ash/blob/master/LICENSE.md) license.