farjs-app/README.md

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

[![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/)

[![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)
[![Downloads](https://img.shields.io/npm/dm/farjs-app.svg)](https://www.pkgstats.com/pkg:farjs-app)
[![Publish Size](https://badgen.net/packagephobia/publish/farjs-app)](https://packagephobia.com/result?p=farjs-app)
[![Install Size](https://badgen.net/packagephobia/install/farjs-app)](https://packagephobia.com/result?p=farjs-app)

## FAR.js

Good old Windows **F**ile and **AR**chive Manager
([FAR](https://en.wikipedia.org/wiki/Far_Manager)) app built with:
  [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/) and [bun](https://bun.sh) on different platforms:
* `Mac OS X` (primary support in [iTerm2](https://iterm2.com/) and [WezTerm](https://wezfurlong.org/wezterm/))
* `Windows` (primary support in [WezTerm](https://wezfurlong.org/wezterm/) and [Windows Terminal](https://docs.microsoft.com/en-us/windows/terminal/))
* `Linux` (primary support in [WezTerm](https://wezfurlong.org/wezterm/))

## 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 (using node) from your favorite terminal:
``` bash
farjs
```

To run using [bun](https://bun.sh) use:
``` bash
bun $(which 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)