README.md

   1 # [![micro logo](./assets/logo.png)](https://micro-editor.github.io)
   2
   3 [![Build Status](https://travis-ci.org/zyedidia/micro.svg?branch=master)](https://travis-ci.org/zyedidia/micro)
   4 [![Go Report Card](https://goreportcard.com/badge/github.com/zyedidia/micro)](https://goreportcard.com/report/github.com/zyedidia/micro)
   5 [![Join the chat at https://gitter.im/zyedidia/micro](https://badges.gitter.im/zyedidia/micro.svg)](https://gitter.im/zyedidia/micro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
   6 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zyedidia/micro/blob/master/LICENSE)
   7 [![Snap Status](https://build.snapcraft.io/badge/zyedidia/micro.svg)](https://build.snapcraft.io/user/zyedidia/micro)
   8
   9 **micro** is a terminal-based text editor that aims to be easy to use and intuitive, while also taking advantage of the capabilities
  10 of modern terminals. It comes as a single, batteries-included, static binary with no dependencies; you can download and use it right away.
  11
  12 As its name indicates, micro aims to be somewhat of a successor to the nano editor by being easy to install and use.
  13 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.
  14
  15 Here is a picture of micro editing its source code.
  16
  17 ![Screenshot](./assets/micro-solarized.png)
  18
  19 To see more screenshots of micro, showcasing all of the default color schemes, see [here](http://zbyedidia.webfactional.com/micro/screenshots.html).
  20
  21 ## Table of Contents
  22
  23 - [Features](#features)
  24 - [Installation](#installation)
  25   - [Prebuilt binaries](#prebuilt-binaries)
  26   - [Package Managers](#package-managers)
  27   - [Building from source](#building-from-source)
  28   - [macOS terminal](#macos-terminal)
  29   - [Linux clipboard support](#linux-clipboard-support)
  30   - [Colors and syntax highlighting](#colors-and-syntax-highlighting)
  31   - [Plan9, Cygwin](#plan9-cygwin)
  32 - [Usage](#usage)
  33 - [Documentation and Help](#documentation-and-help)
  34 - [Contributing](#contributing)
  35
  36 ## Features
  37
  38 - Easy to use and install.
  39 - No dependencies or external files are needed — just the binary you can download further down the page.
  40 - Multiple cursors.
  41 - Common keybindings (<kbd>Ctrl+S</kbd>, <kbd>Ctrl+C</kbd>, <kbd>Ctrl+V</kbd>, <kbd>Ctrl+Z</kbd>, …).
  42   - Keybindings can be rebound to your liking.
  43 - Sane defaults.
  44   - You shouldn't have to configure much out of the box (and it is extremely easy to configure).
  45 - Splits and tabs.
  46 - nano-like menu to help you remember the keybindings.
  47 - Extremely good mouse support.
  48   - This means mouse dragging to create a selection, double click to select by word, and triple click to select by line.
  49 - Cross-platform (it should work on all the platforms Go runs on).
  50   - Note that while Windows is supported, there are still some bugs that need to be worked out.
  51 - Plugin system (plugins are written in Lua).
  52   - micro has a built-in plugin manager to automatically install, remove, and update all your plugins.
  53 - Persistent undo.
  54 - Automatic linting and error notifications
  55 - Syntax highlighting for over [90 languages](runtime/syntax).
  56 - Color scheme support.
  57   - By default, micro comes with 16, 256, and true color themes.
  58 - True color support (set the `MICRO_TRUECOLOR` environment variable to 1 to enable it).
  59 - Snippets.
  60   - The snippet plugin can be installed with `> plugin install snippets`.
  61 - Copy and paste with the system clipboard.
  62 - Small and simple.
  63 - Easily configurable.
  64 - Macros.
  65 - Common editor features such as undo/redo, line numbers, Unicode support, soft wrapping, …
  66
  67 Although not yet implemented, I hope to add more features such as autocompletion ([#174](https://github.com/zyedidia/micro/issues/174)) or a tree view ([#249](https://github.com/zyedidia/micro/issues/249)) in the future.
  68
  69 ## Installation
  70
  71 To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source.
  72
  73 If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro).
  74
  75 ### Prebuilt binaries
  76
  77 All you need to install micro is one file, the binary itself. It's as simple as that!
  78
  79 Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page.
  80
  81 On that page you'll see the nightly release, which contains binaries for micro which are built every night,
  82 and you'll see all the stable releases with the corresponding binaries.
  83
  84 If you'd like to see more information after installing micro, run `micro -version`.
  85
  86 ### Installation script
  87
  88 There is a script which can install micro for you by downloading the latest prebuilt binary. You can find it at <https://getmic.ro>.
  89
  90 Then you can easily install micro:
  91
  92 ```bash
  93 curl https://getmic.ro | bash
  94 ```
  95
  96 The script will install the micro binary to the current directory. See its [GitHub repository](https://github.com/benweissmann/getmic.ro) for more information.
  97
  98 ### Package managers
  99
 100 You can install micro using Homebrew on Mac:
 101
 102 ```
 103 brew install micro
 104 ```
 105
 106 On Windows, you can install micro through [Chocolatey](https://chocolatey.org/) or [Scoop](https://github.com/lukesampson/scoop):
 107
 108 ```
 109 choco install micro
 110 ```
 111
 112 or
 113
 114 ```
 115 scoop install micro
 116 ```
 117
 118 On Linux, you can install micro through [snap](https://snapcraft.io/docs/core/install)
 119
 120 ```
 121 snap install micro --classic
 122 ```
 123
 124 On OpenBSD, micro is available in the ports tree. It is also available as a binary package.
 125
 126 ```
 127 pkg_add -v micro
 128 ```
 129
 130 ### Building from source
 131
 132 If your operating system does not have a binary release, but does run Go, you can build from source.
 133
 134 Make sure that you have Go version 1.5 or greater; Go 1.4 will only work if your version supports cgo.
 135
 136 ```
 137 go get -d github.com/zyedidia/micro/cmd/micro
 138 cd $GOPATH/src/github.com/zyedidia/micro
 139 make install
 140 ```
 141
 142 The binary will then be installed to `$GOPATH/bin` (or your `$GOBIN`).
 143
 144 Please make sure that when you are working with micro's code, you are working on your `GOPATH`.
 145
 146 You can install directly with `go get` (`go get -u github.com/zyedidia/micro/cmd/micro`) but this is not recommended because it doesn't build micro with version information which is useful for the plugin manager.
 147
 148 ### macOS terminal
 149
 150 If you are using macOS, you should consider using [iTerm2](http://iterm2.com/) 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->Load Preset`. The newest versions also support true color.
 151
 152 ### Linux clipboard support
 153
 154 On Linux, clipboard support requires the `xclip` or `xsel` commands to be installed.
 155
 156 For Ubuntu:
 157
 158 ```sh
 159 sudo apt-get install xclip
 160 ```
 161
 162 If you don't have `xclip` or `xsel`, micro will use an internal clipboard for copy and paste, but it won't work with external applications.
 163
 164 ### Colors and syntax highlighting
 165
 166 If you open micro and it doesn't seem like syntax highlighting is working, this is probably because
 167 you are using a terminal which does not support 256 color mode. Try changing the color scheme to `simple`
 168 by pressing <kbd>Ctrl+E</kbd> in micro and typing `set colorscheme simple`.
 169
 170 If you are using the default Ubuntu terminal, to enable 256 make sure your `TERM` variable is set
 171 to `xterm-256color`.
 172
 173 Many of the Windows terminals don't support more than 16 colors, which means
 174 that micro's default color scheme won't look very good. You can either set
 175 the color scheme to `simple`, or download a better terminal emulator, like
 176 mintty.
 177
 178 ### Plan9, Cygwin
 179
 180 Please note that micro uses the amazing [tcell library](https://github.com/gdamore/tcell), but this
 181 means that micro is restricted to the platforms tcell supports. As a result, micro does not support
 182 Plan9, and Cygwin (although this may change in the future). micro also doesn't support NaCl (which is deprecated anyway).
 183
 184 ## Usage
 185
 186 Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.
 187
 188 micro also supports creating buffers from `stdin`:
 189
 190 ```sh
 191 ifconfig | micro
 192 ```
 193
 194 You can move the cursor around with the arrow keys and mouse.
 195
 196 You can also use the mouse to manipulate the text. Simply clicking and dragging
 197 will select text. You can also double click to enable word selection, and triple
 198 click to enable line selection.
 199
 200 ## Documentation and Help
 201
 202 micro has a built-in help system which you can access by pressing <kbd>Ctrl+E</kbd> and typing `help`. Additionally, you can
 203 view the help files here:
 204
 205 - [main help](https://github.com/zyedidia/micro/tree/master/runtime/help/help.md)
 206 - [keybindings](https://github.com/zyedidia/micro/tree/master/runtime/help/keybindings.md)
 207 - [commands](https://github.com/zyedidia/micro/tree/master/runtime/help/commands.md)
 208 - [colors](https://github.com/zyedidia/micro/tree/master/runtime/help/colors.md)
 209 - [options](https://github.com/zyedidia/micro/tree/master/runtime/help/options.md)
 210 - [plugins](https://github.com/zyedidia/micro/tree/master/runtime/help/plugins.md)
 211
 212 I also recommend reading the [tutorial](https://github.com/zyedidia/micro/tree/master/runtime/help/tutorial.md) for
 213 a brief introduction to the more powerful configuration features micro offers.
 214
 215 ## Contributing
 216
 217 If you find any bugs, please report them! I am also happy to accept pull requests from anyone.
 218
 219 You can use the [GitHub issue tracker](https://github.com/zyedidia/micro/issues)
 220 to report bugs, ask questions, or suggest new features.
 221
 222 For a more informal setting to discuss the editor, you can join the [Gitter chat](https://gitter.im/zyedidia/micro).