edit README

The project's README from github.com/microsoft/edit. As one markdown file: README.md.

Application Icon for Edit Edit

A simple editor for simple needs.

This editor pays homage to the classic MS-DOS Editor, but with a modern interface and input controls similar to VS Code. The goal is to provide an accessible editor that even users largely unfamiliar with terminals can easily use.

Screenshot of Edit with the About dialog in the foreground

Installation

Packaging status

You can also download binaries from our Releases page.

Windows

You can install the latest version with WinGet:

winget install Microsoft.Edit

Linux (build from source)

If your distribution does not provide binaries, or if you'd like to build your own, you can use our install script, provided you have installed:

The following command will then install msedit into ~/.local/bin:

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/microsoft/edit/main/assets/install.sh | sh

Additional flags are --dev, to build directly from the main branch, and --system to install into /usr/local/bin. For instance:

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/microsoft/edit/main/assets/install.sh | sh -s -- --dev --system

macOS

You can install the latest version with Homebrew:

brew install msedit

Build Instructions

Build Configuration

You can set the following environment variables at build-time to configure the build:

Environment variable Description
EDIT_CFG_ICU* See ICU library name (SONAME) below for details. Linux package maintainers are advised to review and configure these options.
EDIT_CFG_LANGUAGES A comma-separated list of languages to include in the build. See i18n/edit.toml for available languages.

Notes to Package Maintainers

Package Naming

The canonical executable name is "edit" and the alternative name is "msedit". We're aware of the potential conflict of "edit" with existing commands and recommend alternatively naming packages and executables "msedit". Names such as "ms-edit" should be avoided. Assigning an "edit" alias is recommended, if possible.

ICU library name (SONAME)

This project optionally depends on the ICU library for its Search and Replace functionality.

By default, the project will look for the following library names:

Variable Windows macOS Linux / Other
EDIT_CFG_ICUUC_SONAME icuuc.dll libicucore.dylib libicuuc.so
EDIT_CFG_ICUI18N_SONAME icuin.dll libicucore.dylib libicui18n.so

If your installation uses a different SONAME, please set the following environment variable at build time:

Additionally, this project assumes that the ICU exports symbols without _ prefix and without version suffix, such as u_errorName. If your installation uses versioned exports, please set:

Finally, you can set the following environment variables:

To test your build settings, run cargo test with the --ignored flag. For instance:

cargo test -- --ignored

edit (microsoft/edit)

Searching Database…

14.7K ·GitHub
Что это такое?Edit — это небольшой текстовый редактор для терминала от Microsoft, сделанный для быстрых и простых задач. Это оммаж классическому MS-DOS Editor, воссозданный с современным интерфейсом и элементами управления в духе VS Code.
Он работает в терминале или это программа с графическим интерфейсом?Он запускается в терминале, но не ощущается как классический модальный терминальный редактор — интерфейс и элементы управления сделаны по образцу VS Code, так что внутри окна терминала он ведет себя как современное приложение.
Что установочному скрипту на Linux нужно сначала иметь на машине?Rust (через rustup), компилятор C вроде gcc, ICU, а также curl/wget и tar. Затем скрипт устанавливает msedit в ~/.local/bin, либо можно передать --system, чтобы поставить в /usr/local/bin, или --dev, чтобы собрать из ветки main.
После установки есть подводные камни с именем?Да — каноничное имя исполняемого файла — 'edit', и оно может пересекаться с уже существующими командами, поэтому пакетам советуют поставлять его как 'msedit' (имен вроде 'ms-edit' следует избегать) и при желании делать алиас 'edit' на него.
Я почти не знаком с терминальными редакторами — мне это по силам?Именно для вас он и создан: заявленная цель — доступный редактор, которым легко могут пользоваться люди, почти не знакомые с терминалом, с привычными элементами управления в стиле VS Code вместо заклинаний из клавиатурных комбинаций.
Стоит ли собирать на nightly Rust вместо стабильной версии?Да — в README советуют задать RUSTCBOOTSTRAP=1 и собирать на nightly, потому что это заметно уменьшает размер бинарника и немного повышает производительность. Стабильный Rust тоже вполне работает, если вам так привычнее.
Почему сборке важна библиотека ICU?Функция Search and Replace опционально зависит от ICU, а в разных дистрибутивах ее библиотеки называются по-разному, поэтому сборщики могут указать нужную через переменные вроде EDITCFGICUUCSONAME и EDITCFGICUI18NSONAME.
Можно ли собрать только с частью языков интерфейса?Да — задайте переменную окружения EDITCFGLANGUAGES со списком языков через запятую при сборке; доступные языки перечислены в файле i18n/edit.toml.
What are similar projects?spotify-tui, hexyl, winget-cli, fx, micro, vis, toast, lazygit
Creator
microsoft
Size
2.6 MB
Stars
14.7K
Age
1y
Commits · 90 Days