runtime/help/commands.md

   1 # Possible commands
   2
   3 You can execute an editor command by pressing `Ctrl-e` followed by the command.
   4 Here are the possible commands that you can use.
   5
   6 * `quit`: Quits micro.
   7
   8 * `save filename?`: Saves the current buffer. If the filename is provided it will
   9    'save as' the filename.
  10
  11 * `replace "search" "value" flags`: This will replace `search` with `value`.
  12    The `flags` are optional.
  13    At this point, there is only one flag: `c`, which enables `check` mode
  14    which asks if you'd like to perform the replacement each time.
  15
  16    Note that `search` must be a valid regex.  If one of the arguments
  17    does not have any spaces in it, you may omit the quotes.
  18
  19 * `set option value`: sets the option to value. See the `options` help topic
  20    for a list of options you can set.
  21
  22 * `setlocal option value`: sets the option to value locally (only in the current
  23    buffer).
  24
  25 * `show option`: shows the current value of the given option.
  26
  27 * `eval "expression"`: Evaluates a Lua expression. Note that micro will not
  28    print anything so you should use `messenger:Message(...)` to display a
  29    value.
  30
  31 * `run sh-command`: runs the given shell command in the background. The
  32    command's output will be displayed in one line when it finishes running.
  33
  34 * `bind key action`: creates a keybinding from key to action. See the sections on
  35    keybindings above for more info about what keys and actions are available.
  36
  37 * `vsplit filename`: opens a vertical split with `filename`. If no filename is
  38    provided, a vertical split is opened with an empty buffer.
  39
  40 * `hsplit filename`: same as `vsplit` but opens a horizontal split instead of
  41    a vertical split.
  42
  43 * `tab filename`: opens the given file in a new tab.
  44
  45 * `log`: opens a log of all messages and debug statements.
  46
  47 * `plugin install plugin_name`: installs the given plugin.
  48
  49 * `plugin remove plugin_name`: removes the given plugin.
  50
  51 * `plugin list`: lists all installed plugins.
  52
  53 * `plugin update`: updates all installed plugins.
  54
  55 * `plugin search plugin_name`: searches for the given plugin.
  56    Note that you can find a list of all available plugins at
  57    github.com/micro-editor/plugin-channel.
  58
  59    You can also see more information about the plugin manager
  60    in the `Plugin Manager` section of the `plugins` help topic.
  61
  62 * `plugin available`: list plugins available for download (this includes
  63    any plugins that may be already installed).
  64
  65 * `reload`: reloads all runtime files.
  66
  67 ---
  68
  69 The following commands are provided by the default plugins:
  70
  71 * `lint`: Lint the current file for errors.