farjs-app/README.md

FAR.js - Cross-platform File and Archive Manager app in your terminal

[![CI](https://github.com/farjs/farjs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/farjs/farjs/actions/workflows/ci.yml?query=workflow%3Aci+branch%3Amain)
[![Coverage Status](https://coveralls.io/repos/github/farjs/farjs/badge.svg?branch=main)](https://coveralls.io/github/farjs/farjs?branch=main)
[![npm version](https://img.shields.io/npm/v/farjs-app)](https://www.npmjs.com/package/farjs-app)
[![Rate on Openbase](https://badges.openbase.com/js/rating/farjs-app.svg)](https://openbase.com/js/farjs-app?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge)
[![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.13.0.svg)](https://www.scala-js.org)

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
[![Русский корабль, иди на хуй!](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/RussianWarship.svg)](https://vshymanskyy.github.io/StandWithUkraine)

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine/)


## FAR.js

Good old Windows **F**ile and **AR**chive Manager
([FAR](https://en.wikipedia.org/wiki/Far_Manager)) app built with:
  [Scala.js](https://www.scala-js.org/),
  [React.js](https://reactjs.org/),
  [react-blessed](https://github.com/Yomguithereal/react-blessed),
  [blessed](https://github.com/chjj/blessed)

Runs on [Node.js](https://nodejs.org/), thus cross-platform:
* `Mac OS X` (primary support in [iTerm2](https://iterm2.com/) terminal)
* `Windows` (primary support in [Windows Terminal](https://docs.microsoft.com/en-us/windows/terminal/))
* `Linux`

## Install

To install (or upgrade) it on your computer use the following command:

``` bash
$ npm i -g farjs-app
```

then you can run the application from your favorite terminal:

``` bash
$ farjs
```

![Screenshots](https://raw.githubusercontent.com/farjs/farjs/main/docs/images/screenshots.png)

## Documentation

Please, visit [FAR.js](https://farjs.github.io) web-site
for the full documentation.

## Contributing

See [develop.md](https://github.com/farjs/farjs/blob/main/develop.md)