micro README

The project's README from github.com/micro-editor/micro. As one markdown file: README.md.

micro logo

Test Workflow Release MIT License Join the chat at https://gitter.im/zyedidia/micro Snap Status

micro is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the capabilities of modern terminals. It comes as a single, batteries-included, static binary with no dependencies; you can download and use it right now!

As its name indicates, micro aims to be somewhat of a successor to the nano editor by being easy to install and use. It strives to be enjoyable as a full-time editor for people who prefer to work in a terminal, or those who regularly edit files over SSH.

Here is a picture of micro editing its source code.

Screenshot

To see more screenshots of micro, showcasing some of the default color schemes, see here.

You can also check out the website for Micro at https://micro-editor.github.io.


Features

Installation

To install micro, you can download a prebuilt binary, or you can build it from source.

If you want more information about ways to install micro, see this wiki page.

Use micro -version to get the version information after installing. It is only guaranteed that you are installing the most recent stable version if you install from the prebuilt binaries, Homebrew, or Snap.

A desktop entry file and man page can be found in the assets/packaging directory.

Pre-built binaries

Pre-built binaries are distributed in releases.

To uninstall micro, simply remove the binary, and the configuration directory at ~/.config/micro.

Third-party quick-install script

curl https://getmic.ro | bash

The script will place the micro binary in the current directory. From there, you can move it to a directory on your path of your choosing (e.g. sudo mv micro /usr/bin). See its GitHub repository for more information.

Eget

With Eget installed, you can easily get a pre-built binary:

eget micro-editor/micro

Use --tag VERSION to download a specific tagged version.

eget --tag nightly micro-editor/micro # download the nightly version (compiled every day at midnight UTC)
eget --tag v2.0.8 micro-editor/micro  # download version 2.0.8 rather than the latest release

You can install micro by adding --to /usr/local/bin to the eget command, or move the binary manually to a directory on your $PATH after the download completes.

See Eget for more information.

Package managers

You can install micro using Homebrew on Mac:

brew install micro

Note for Mac: All micro keybindings use the control or alt (option) key, not the command key. By default, macOS terminals do not forward alt key events. To fix this, please see the section on macOS terminals further below.

On Linux, you can install micro through snap

snap install micro --classic

Micro is also available through other package managers on Linux such as dnf, AUR, Nix, and package managers for other operating systems. These packages are not guaranteed to be up-to-date.

Note for Linux desktop environments:

For interfacing with the local system clipboard, the following tools need to be installed:

Without these tools installed, micro will use an internal clipboard for copy and paste, but it won't be accessible to external applications.

Building from source

If your operating system does not have a binary release, but does run Go, you can build from source.

Make sure that you have Go version 1.19 or greater and Go modules are enabled.

git clone https://github.com/micro-editor/micro
cd micro
make build
sudo mv micro /usr/local/bin # optional

The binary will be placed in the current directory and can be moved to anywhere you like (for example /usr/local/bin).

The command make install will install the binary to $GOPATH/bin or $GOBIN.

You can install directly with go get (go get github.com/micro-editor/micro/cmd/micro) but this isn't recommended because it doesn't build micro with version information (necessary for the plugin manager), and doesn't disable debug mode.

Fully static or dynamically linked binary

By default, the micro binary is linked statically to increase the portability of the prebuilt binaries. This behavior can simply be overriden by providing CGO_ENABLED=1 to the build target.

CGO_ENABLED=1 make build

Afterwards the micro binary will dynamically link with the present core system libraries.

Note for Mac: Native macOS builds are done with CGO_ENABLED=1 forced set to support adding the "Information Property List" in the linker step.

macOS terminal

If you are using macOS, you should consider using iTerm2 instead of the default terminal (Terminal.app). The iTerm2 terminal has much better mouse support as well as better handling of key events. For best keybinding behavior, choose xterm defaults under Preferences->Profiles->Keys->Presets..., and select Esc+ for Left Option Key in the same menu. The newest versions also support true color.

If you still insist on using the default Mac terminal, be sure to set Use Option key as Meta key under Preferences->Profiles->Keyboard to use option as alt.

WSL and Windows Console

If you use micro within WSL, it is highly recommended that you use the Windows Terminal instead of the default Windows Console.

If you must use Windows Console for some reason, note that there is a bug in Windows Console WSL that causes a font change whenever micro tries to access the external clipboard via powershell. To fix this, use an internal clipboard with set clipboard internal (though your system clipboard will no longer be available in micro).

Colors and syntax highlighting

If you open micro and it doesn't seem like syntax highlighting is working, this is probably because you are using a terminal which does not support 256 color mode. Try changing the color scheme to simple by pressing Ctrl-e in micro and typing set colorscheme simple.

If you are using the default Ubuntu terminal, to enable 256 color mode make sure your TERM variable is set to xterm-256color.

Many of the Windows terminals don't support more than 16 colors, which means that micro's default color scheme won't look very good. You can either set the color scheme to simple, or download and configure a better terminal emulator than the Windows default.

Cygwin, Mingw, Plan9

Cygwin, Mingw, and Plan9 are unfortunately not officially supported. In Cygwin and Mingw, micro will often work when run using the winpty utility:

winpty micro.exe ...

Micro uses the amazing tcell library, but this means that micro is restricted to the platforms tcell supports. As a result, micro does not support Plan9 or Cygwin (although this may change in the future). Micro also doesn't support NaCl (which is deprecated anyway).

Usage

Once you have built the editor, start it by running micro path/to/file.txt or micro to open an empty buffer.

micro also supports creating buffers from stdin:

ip a | micro

You can move the cursor around with the arrow keys and mouse.

You can also use the mouse to manipulate the text. Simply clicking and dragging will select text. You can also double click to enable word selection, and triple click to enable line selection.

Documentation and Help

micro has a built-in help system which you can access by pressing Ctrl-e and typing help. Additionally, you can view the help files here:

I also recommend reading the tutorial for a brief introduction to the more powerful configuration features micro offers.

There is also an unofficial Discord, which you can join at https://discord.gg/nhWR6armnR.

Contributing

If you find any bugs, please report them! I am also happy to accept pull requests from anyone.

You can use the GitHub issue tracker to report bugs, ask questions, or suggest new features.

For a more informal setting to discuss the editor, you can join the Gitter chat or the Discord. You can also use the Discussions section on GitHub for a forum-like setting or for Q&A.

Sometimes I am unresponsive, and I apologize! If that happens, please ping me.

micro (micro-editor/micro)

Searching Database…

29.7K ·GitHub
这是什么?micro 是一个基于终端的文本编辑器,追求简单易用、直观上手——有点像 nano 的后继者。它打包成单个静态二进制文件,无论日常在终端里工作还是通过 SSH 使用都很舒服。
它和直接用 nano 有什么区别?延续了同样易装易用的风格,但更现代化:支持多光标、分屏和标签页,鼠标支持很完善,还有插件系统,以及对超过 130 种语言的语法高亮。
运行它还需要装别的东西吗?不需要——它自带一个静态链接的二进制文件,没有任何依赖或外部文件。只有自己从源码编译时才需要 Go 1.19+。
在 macOS 或 Windows 的终端上有什么坑吗?终端很关键:macOS 默认不转发 alt 键(推荐用 iTerm2 而不是 Terminal.app),在 WSL 下要用 Windows Terminal,而且很多 Windows 终端只显示 16 色,导致默认主题看起来很糟糕。
它能在哪些平台上运行?凡是 Go 能运行的平台都可以:Windows、macOS、Linux 和各种 BSD。Cygwin、Mingw 和 Plan9 不受支持,因为 micro 受限于 tcell 终端库所支持的范围。
除了基础功能它还能做什么?多光标、分屏和标签页、宏、持久化撤销、内置 diff 侧边栏、简单的自动补全、自动 lint 并提示错误,还能智能高亮行尾多余空格以及 tab 和空格混用的错误。
一次典型的编辑过程是什么样的?用 micro path/to/file.txt 打开文件,或者直接运行 micro 打开一个空缓冲区;缓冲区甚至可以从 stdin 创建。类似 nano 的菜单能帮你记住快捷键,按 Ctrl-e 再输入 help 可以打开内置帮助系统。
删除或重置它麻烦吗?只要删掉那个二进制文件和 ~/.config/micro 配置目录就行了——卸载就这么简单,不会留下任何别的东西。
包管理器里的版本总是最新的吗?只有预编译二进制文件、Homebrew 和 Snap 能保证是最新稳定版,发行版的软件包可能会滞后。不建议用 go get 来编译——它会丢失插件管理器需要的版本信息,而且会保留调试模式。
What are similar projects?toast, edit, helix, vis, slides, lime, awesome-neovim, vimrc
Size
13.8 MB
Stars
29.7K
Age
10y
Commits · 90 Days