2016-07-28 22:52:31 +03:00
|
|
|
# Possible commands
|
|
|
|
|
|
|
|
You can execute an editor command by pressing `Ctrl-e` followed by the command.
|
|
|
|
Here are the possible commands that you can use.
|
|
|
|
|
|
|
|
* `quit`: Quits micro.
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
* `save filename?`: Saves the current buffer. If the filename is provided it
|
|
|
|
will 'save as' the filename.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
|
|
|
* `replace "search" "value" flags`: This will replace `search` with `value`.
|
2017-11-22 21:54:39 +03:00
|
|
|
The `flags` are optional. Possible flags are:
|
|
|
|
* `-a`: Replace all occurrences at once
|
|
|
|
* `-l`: Do a literal search instead of a regex search
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-11-22 21:54:39 +03:00
|
|
|
Note that `search` must be a valid regex (unless `-l` is passed). If one
|
|
|
|
of the arguments does not have any spaces in it, you may omit the quotes.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-05-26 02:13:57 +03:00
|
|
|
* `replaceall "search" "value"`: This will replace `search` with `value` without
|
2017-10-11 16:16:53 +03:00
|
|
|
user confirmation.
|
2017-05-26 02:13:57 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
See `replace` command for more information.
|
2017-05-26 02:13:57 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
* `set option value`: sets the option to value. See the `options` help topic for
|
|
|
|
a list of options you can set.
|
2016-08-26 00:24:13 +03:00
|
|
|
|
|
|
|
* `setlocal option value`: sets the option to value locally (only in the current
|
|
|
|
buffer).
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2016-08-29 04:48:03 +03:00
|
|
|
* `show option`: shows the current value of the given option.
|
|
|
|
|
2016-09-09 22:54:32 +03:00
|
|
|
* `eval "expression"`: Evaluates a Lua expression. Note that micro will not
|
2017-10-11 16:16:53 +03:00
|
|
|
print anything so you should use `messenger:Message(...)` to display a value.
|
2016-09-09 22:54:32 +03:00
|
|
|
|
2016-07-28 22:52:31 +03:00
|
|
|
* `run sh-command`: runs the given shell command in the background. The
|
|
|
|
command's output will be displayed in one line when it finishes running.
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
* `bind key action`: creates a keybinding from key to action. See the sections
|
|
|
|
on keybindings above for more info about what keys and actions are available.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
|
|
|
* `vsplit filename`: opens a vertical split with `filename`. If no filename is
|
2016-10-06 01:26:41 +03:00
|
|
|
provided, a vertical split is opened with an empty buffer.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
* `hsplit filename`: same as `vsplit` but opens a horizontal split instead of a
|
|
|
|
vertical split.
|
2016-07-28 22:52:31 +03:00
|
|
|
|
|
|
|
* `tab filename`: opens the given file in a new tab.
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
* `tabswitch tab`: This command will switch to the specified tab. The `tab` can
|
|
|
|
either be a tab number, or a name of a tab.
|
|
|
|
|
2016-10-06 01:26:41 +03:00
|
|
|
* `log`: opens a log of all messages and debug statements.
|
|
|
|
|
|
|
|
* `plugin install plugin_name`: installs the given plugin.
|
|
|
|
|
|
|
|
* `plugin remove plugin_name`: removes the given plugin.
|
|
|
|
|
|
|
|
* `plugin list`: lists all installed plugins.
|
|
|
|
|
|
|
|
* `plugin update`: updates all installed plugins.
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
* `plugin search plugin_name`: searches for the given plugin. Note that you can
|
|
|
|
find a list of all available plugins at
|
2016-10-06 01:26:41 +03:00
|
|
|
github.com/micro-editor/plugin-channel.
|
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
You can also see more information about the plugin manager in the
|
|
|
|
`Plugin Manager` section of the `plugins` help topic.
|
2016-09-27 21:29:55 +03:00
|
|
|
|
2017-10-11 16:16:53 +03:00
|
|
|
* `plugin available`: list plugins available for download (this includes any
|
|
|
|
plugins that may be already installed).
|
2016-10-25 02:02:13 +03:00
|
|
|
|
2016-10-21 18:51:36 +03:00
|
|
|
* `reload`: reloads all runtime files.
|
|
|
|
|
2016-11-19 00:48:08 +03:00
|
|
|
* `cd path`: Change the working directory to the given `path`.
|
|
|
|
|
|
|
|
* `pwd`: Print the current working directory.
|
|
|
|
|
2016-11-19 20:57:54 +03:00
|
|
|
* `open filename`: Open a file in the current buffer.
|
|
|
|
|
2017-11-21 08:51:07 +03:00
|
|
|
* `retab`: Replaces all leading tabs with spaces or leading spaces with tabs
|
|
|
|
depending on the value of `tabstospaces`.
|
|
|
|
|
2017-11-29 09:06:16 +03:00
|
|
|
* `raw`: Micro will open a new tab and show the escape sequence for every event
|
|
|
|
it receives from the terminal. This shows you what micro actually sees from
|
|
|
|
the terminal and helps you see which bindings aren't possible and why. This
|
|
|
|
is most useful for debugging keybindings.
|
|
|
|
|
2017-12-03 21:05:46 +03:00
|
|
|
* `showkey`: Show the action(s) bound to a given key. For example
|
|
|
|
running `> showkey CtrlC` will display `main.(*View).Copy`. Unfortuately
|
|
|
|
showkey does not work well for keys bound to plugin actions. For those
|
|
|
|
it just shows "LuaFunctionBinding."
|
|
|
|
|
2016-08-17 21:19:59 +03:00
|
|
|
---
|
|
|
|
|
|
|
|
The following commands are provided by the default plugins:
|
|
|
|
|
|
|
|
* `lint`: Lint the current file for errors.
|
2017-11-22 21:54:39 +03:00
|
|
|
|
|
|
|
# Command Parsing
|
|
|
|
|
|
|
|
When running a command, you can use extra syntax that micro will expand before
|
|
|
|
running the command. To use an argument with a space in it, simply put it in
|
|
|
|
quotes. You can also use environment variables in the command bar and they
|
|
|
|
will be expanded to their value. Finally, you can put an expression in backticks
|
|
|
|
and it will be evaluated by the shell beforehand.
|