Skip to content
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

117 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eve

Build Status CodeQL CodeScene Code Health Code Size PRs Welcome

A user-friendly command-line text editor.

eve is a lightweight, user-friendly text editor for the terminal that aims to be simple and intuitive, while also taking advantage of the capabilities of advanced text editor like Vim or Emacs.

The project is in alpha stage and will provides essential and powerful editing features (see Roadmap), making it ideal for editing configuration files, creating scripts or witing source codes from the command-line.

Getting Started

Prerequisites

  • A Unix-like operating system: Linux, BSD, macOS. On Windows, you can use WSL2 or Cygwin, etc. On Android, use Termux.
  • Tools for building the binary:
    • make
    • gcc

You can install all the required tools on Linux with this command:

sudo apt install make gcc

Compiling

If you haven't already clone the repository:

sudo apt install git
git clone https://github.com/cezelot/eve.git

Navigate to the repo directory and run make:

cd eve
make

It'll build a binary named eve.

If you want to install eve, copy the compiled binary into ~/.local/bin:

cp eve ~/.local/bin

Or into /usr/local/bin, note that you must have adequate privileges:

sudo cp eve /usr/local/bin

Make rules

Command Description
make Compile eve.
make clean Remove objects files.
make fclean Remove objects files and eve.
make re Re-compile eve.

Usage

To open and edit a file, remove ./ if you have installed the binary:

./eve <filename>

Roadmap

List of features planned for version 1.0.0:

  • Display text files
  • Edit text files
  • Search feature
  • Syntax highlighting and filetype detection
  • Line number
  • Config file
  • Text formatting
    • Soft indent
    • Auto indent
    • Hard-wrap lines
    • Soft-wrap lines
  • Cut, Copy and paste
  • Modal editing
  • Undo/Redo

Contributing

Pull requests are welcome. For reporting a bug or suggesting an enhancement, feel free to open an issue.

Please make sure to read the contributing guidelines before.

Authors

Ismael Benjara - @cezelot - contact

See also the list of contributors who participated in this project.

License

eve is free software distributed under the GNU Public License, for details see COPYING.

About

Terminal-based text editor

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages