3 The command bar is opened by pressing Ctrl-e. It is a single-line buffer,
4 meaning that all keybindings from a normal buffer are supported (as well
5 as mouse and selection).
7 When running a command, you can use extra syntax that micro will expand before
8 running the command. To use an argument with a space in it, put it in
9 quotes. The command bar parser uses the same rules for parsing arguments that
10 `/bin/sh` would use (single quotes, double quotes, escaping). The command bar
11 does not look up environment variables.
15 Micro provides the following commands that can be executed at the command-bar
16 by pressing `Ctrl-e` and entering the command. Arguments are placed in single
17 quotes here but these are not necessary when entering the command in micro.
19 * `bind 'key' 'action'`: creates a keybinding from key to action. See the
20 `keybindings` documentation for more information about binding keys.
21 This command will modify `bindings.json` and overwrite any bindings to
22 `key` that already exist.
24 * `help 'topic'?`: opens the corresponding help topic. If no topic is provided
25 opens the default help screen.
27 * `save 'filename'?`: saves the current buffer. If the file is provided it
28 will 'save as' the filename.
30 * `quit`: quits micro.
32 * `goto 'line'`: jumps to the given line number. A negative number can be
33 passed to jump inward from the end of the file; for example, -5 jumps
34 to the 5th-last line in the file.
36 * `replace 'search' 'value' 'flags'?`: This will replace `search` with `value`.
37 The `flags` are optional. Possible flags are:
38 * `-a`: Replace all occurrences at once
39 * `-l`: Do a literal search instead of a regex search
41 Note that `search` must be a valid regex (unless `-l` is passed). If one
42 of the arguments does not have any spaces in it, you may omit the quotes.
44 * `replaceall 'search' 'value'`: this will replace all occurrences of `search`
45 with `value` without user confirmation.
47 See `replace` command for more information.
49 * `set 'option' 'value'`: sets the option to value. See the `options` help
50 topic for a list of options you can set. This will modify your
51 `settings.json` with the new value.
53 * `setlocal 'option' 'value'`: sets the option to value locally (only in the
54 current buffer). This will *not* modify `settings.json`.
56 * `show 'option'`: shows the current value of the given option.
58 * `run 'sh-command'`: runs the given shell command in the background. The
59 command's output will be displayed in one line when it finishes running.
61 * `vsplit 'filename'`: opens a vertical split with `filename`. If no filename
62 is provided, a vertical split is opened with an empty buffer.
64 * `hsplit 'filename'`: same as `vsplit` but opens a horizontal split instead
67 * `tab 'filename'`: opens the given file in a new tab.
69 * `tabmove '[-+]?n'`: Moves the active tab to another slot. `n` is an integer.
70 If `n` is prefixed with `-` or `+`, then it represents a relative position
71 (e.g. `tabmove +2` moves the tab to the right by `2`). If `n` has no prefix,
72 it represents an absolute position (e.g. `tabmove 2` moves the tab to slot `2`).
74 * `tabswitch 'tab'`: This command will switch to the specified tab. The `tab`
75 can either be a tab number, or a name of a tab.
77 * `textfilter 'sh-command'`: filters the current selection through a shell
78 command as standard input and replaces the selection with the stdout of
79 the shell command. For example, to sort a list of numbers, first select
80 them, and then execute `> textfilter sort -n`.
82 * `log`: opens a log of all messages and debug statements.
84 * `plugin list`: lists all installed plugins.
86 * `plugin install 'pl'`: install a plugin.
88 * `plugin remove 'pl'`: remove a plugin.
90 * `plugin update 'pl'`: update a plugin (if no arguments are provided
93 * `plugin search 'pl'`: search available plugins for a keyword.
95 * `plugin available`: show available plugins that can be installed.
97 * `reload`: reloads all runtime files.
99 * `cd 'path'`: Change the working directory to the given `path`.
101 * `pwd`: Print the current working directory.
103 * `open 'filename'`: Open a file in the current buffer.
105 * `reset 'option'`: resets the given option to its default value
107 * `retab`: Replaces all leading tabs with spaces or leading spaces with tabs
108 depending on the value of `tabstospaces`.
110 * `raw`: micro will open a new tab and show the escape sequence for every event
111 it receives from the terminal. This shows you what micro actually sees from
112 the terminal and helps you see which bindings aren't possible and why. This
113 is most useful for debugging keybindings.
115 * `showkey`: Show the action(s) bound to a given key. For example
116 running `> showkey Ctrl-c` will display `Copy`.
118 * `term exec?`: Open a terminal emulator running the given executable. If no
119 executable is given, this will open the default shell in the terminal
124 The following commands are provided by the default plugins:
126 * `lint`: Lint the current file for errors.
127 * `comment`: automatically comment or uncomment current selection or line.