<img alt="logo.svg" src="https://raw.githubusercontent.com/rsvim/assets/main/logo/RSVIM-logo.svg" /> The VIM editor reinvented in Rust+TypeScript. <a href="https://crates.io/crates/rsvim"><img alt="rsvim" src="https://img.shields.io/crates/v/rsvim" /></a> <a href="https://www.npmjs.com/package/@rsvim/types"><img alt="rsvim" src="https://img.shields.io/npm/v/%40rsvim%2Ftypes" /></a> <a href="https://docs.rs/rsvim_core/latest/"><img alt="rsvim_core" src="https://img.shields.io/docsrs/rsvim_core?label=docs.rs" /></a> <a href="https://github.com/rsvim/rsvim/actions/workflows/release.yml"><img alt="release.yml" src="https://img.shields.io/github/actions/workflow/status/rsvim/rsvim/release.yml" /></a> <a href="https://github.com/rsvim/rsvim/actions/workflows/ci.yml"><img alt="ci.yml" src="https://img.shields.io/github/actions/workflow/status/rsvim/rsvim/ci.yml?branch=main&label=ci" /></a> <a href="https://app.codecov.io/gh/rsvim/rsvim"><img alt="codecov" src="https://img.shields.io/codecov/c/github/rsvim/rsvim" /></a> <a href="https://discord.gg/5KtRUCAByB"><img alt="discord" src="https://img.shields.io/discord/1220171472329379870?logo=discord&style=social&label=discord" /></a>

[!CAUTION]

This project is still in very early stage of development and not ready for use. Please choose alternatives Neovim and Vim.

About

RSVIM is an open source terminal based text editor, built from scratch with Rust, Tokio and V8 javascript engine. It strives to be highly extensible by following main features, concepts, philosophy of (Neo)Vim, while also to be:

A fast editor that fully utilizes all CPU cores and never freezes.
A powerful TUI engine that provides widgets, event handlers, layouts, etc.
A consistent JavaScript-based runtime with built-in support for TypeScript.
An editing service that allows multiple users to access remotely and work together.
A text processing tool that integrates with shell environment.

Installation

Please download prebuilt executables in releases page, or build with cargo:

cargo install --locked rsvim

To get latest updates, build with git source on main branch:

cargo install --locked rsvim --git https://github.com/rsvim/rsvim.git --branch main

Get Started

Please check out Documentation for more details!

Contribution

Contributions to RSVIM are always welcomed. A few guidelines that help quickly set up development environment can be found in DEVELOPMENT.md.

Road map and high-level design can be found in RFC, please submit your ideas and designs there if they need fairly large efforts.

Credits

Some source code are studied from following projects for implementing the initial prototype of javascript runtime and Minimum Common Web Platform API:

dune: A hobby runtime for JavaScript and TypeScript 🚀.
deno: A modern runtime for JavaScript and TypeScript.

Supporting the Project

If you like RSVIM, please consider sponsoring it. Your support encourages contributors and maintainers of this project, and other fees or efforts spent on it.

License

Licensed under Vim License.

Rsvim

Install / Use

README