github.com/skywind3000/asyncrun.vim
This plugin takes the advantage of new APIs in Vim 8 (and NeoVim) to enable you to run shell commands in the background and read the output in the quickfix window in realtime:
:AsyncRun (just like old ! cmd).errorformat.asyncrun.vim source file.If that doesn't excite you, then perhaps this GIF screen capture below will change your mind.
-mode=term see here.:%AsyncRun cat.Install with vim-plug:
Plug 'skywind3000/asyncrun.vim'
Remember to open vim's quickfix window by :copen (or setting g:asyncrun_open) before invoking AsyncRun, otherwise, you will not see any output.
Async run gcc to compile current file
:AsyncRun gcc "$(VIM_FILEPATH)" -o "$(VIM_FILEDIR)/$(VIM_FILENOEXT)"
:AsyncRun g++ -O3 "$(VIM_FILEPATH)" -o "$(VIM_FILEDIR)/$(VIM_FILENOEXT)" -lpthread
This command will run gcc in the background and output to the quickfix window in real time. Macro '$(VIM_FILEPATH)' stands for filename with full path and '$(VIM_FILENOEXT)' represents filename without extension.
Async run make
:AsyncRun make
:AsyncRun make -f makefile
Remember to open the quickfix window by :copen before using the AsyncRun command, if you don't open it, you will not see any output.
Grep key word
:AsyncRun! grep -R -n word .
:AsyncRun! grep -R -n <cword> .
when ! is included, auto-scroll in quickfix will be disabled. <cword> represents current word under cursor.
Compile go project
:AsyncRun go build "$(VIM_FILEDIR)"
Macro '$(VIM_FILEDIR)' stands for the current file dir.
Lookup man page
:AsyncRun! man -S 3:2:1 <cword>
Git push
:AsyncRun git push origin master
Git push from project root
:AsyncRun -cwd=<root> git push origin master
Use -cwd=? to specify the working directory, macro <root> or $(VIM_ROOT) represents current Project Root.
Setup <F7> to compile file
:noremap <F7> :AsyncRun gcc "$(VIM_FILEPATH)" -o "$(VIM_FILEDIR)/$(VIM_FILENAME)" <cr>
File name may contain spaces, therefore, it's safe to quote them.
Run a python script
:AsyncRun -cwd=$(VIM_FILEDIR) python "$(VIM_FILEPATH)"
New option -raw will display the raw output (without matching to errorformat). Remember to put let $PYTHONUNBUFFERED=1 in your .vimrc to disable python stdout buffering, see here.
Run a python script in a new terminal
:AsyncRun -cwd=$(VIM_FILEDIR) -mode=term -pos=TAB python "$(VIM_FILEPATH)"
This will run python in the internal-terminal (vim 8.2 or nvim-0.4.0 is required) in a new tabpage.
A good assistant to asyncrun
asynctasks.vim a plugin built upon asyncrun, an easy way to use asyncrun. It allows you to manage your building, testing, and deploying tasks in a global or project local configuration, and run them by their names.
There are two vim commands: :AsyncRun and :AsyncStop to control async jobs.
:AsyncRun[!] [options] {cmd} ...
Run shell command in the background and output to quickfix. when ! is included, auto-scroll in quickfix will be disabled. Parameters are split by space, if a parameter contains space, it should be quoted or escaped as backslash + space (Unix only).
Macro variables in the parameters will be expanded before executing:
$(VIM_FILEPATH) - File name of current buffer with full path
$(VIM_FILENAME) - File name of current buffer without path
$(VIM_FILEDIR) - Full path of current buffer without the file name
$(VIM_FILEEXT) - File extension of current buffer
$(VIM_FILENOEXT) - File name of current buffer without path and extension
$(VIM_PATHNOEXT) - Current file name with full path but without extension
$(VIM_CWD) - Current directory
$(VIM_RELDIR) - File path relativize to current directory
$(VIM_RELNAME) - File name relativize to current directory
$(VIM_ROOT) - Project root directory
$(VIM_CWORD) - Current word under cursor
$(VIM_CFILE) - Current filename under cursor
$(VIM_GUI) - Is running under gui ?
$(VIM_VERSION) - Value of v:version
$(VIM_COLUMNS) - How many columns in vim's screen
$(VIM_LINES) - How many lines in vim's screen
$(VIM_SVRNAME) - Value of v:servername for +clientserver usage
$(VIM_PRONAME) - Name of current project root directory
$(VIM_DIRNAME) - Name of current directory
Environment variables with same name, like $VIM_FILENAME, are also initialized. Thus your child process can access them with getenv(xxx) at any time.
Some macros variables have their short names starting with '<' :
<cwd> - Current directory
<cword> - Current word under cursor
<cfile> - Current file name under cursor
<root> - Project root directory
They are also acceptable. So, you can use both $(VIM_ROOT) or its alias <root> to represent Project Root of the current file. Macro variables can be quoted with "..." in the command string when file name contains spaces (like normal shell command escaping), but they should not be quoted in the -cwd=? option.
There can be some options before your [cmd]:
| Option | Default | Description |
|---|---|---|
-mode=? | "async" | specify how to run the command as -mode=?, available modes are "async" (default), "bang" (with ! command) and "terminal" (in internal terminal), see running modes for details. |
-cwd=? | unset | initial directory (use current directory if unset), for example use -cwd=<root> to run commands in project root directory, or -cwd=$(VIM_FILEDIR) to run commands in current buffer's parent directory. |
-save=? | 0 | use -save=1 to save current file, -save=2 to save all modified files before executing. |
-program=? | unset | set to make to use &makeprg, grep to use &grepprt and wsl to execute commands in WSL (windows 10), see command modifiers. |
-post=? | unset | vimscript to exec after job finished, spaces must be escaped to '\ ' |
-auto=? | unset | event name to trigger QuickFixCmdPre/QuickFixCmdPost [name] autocmd. |
-raw | unset | use raw output if present, and &errorformat will be ignored. |
-strip | unset | remove the heading/trailing messages if it is present (omit command and "[Finished in ...]" message). |
-errorformat=? | unset | errorformat for error matching, if it is unprovided, use current &errorformat value. Beware that % needs to be escaped into \%. |
-silent | unset | provide -silent to prevent open quickfix window (will override g:asyncrun_open temporarily) |
-scroll=? | unset | set to 0 to prevent quickfix auto-scrolling |
-once | unset | provide to buffer all output and flush when job is finished, useful when there are multi-line patterns in your errorformat |
-encoding=? | unset | specify command encoding independently (overshadow g:asyncrun_encs) |
-pos=? | "bottom" | When using internal terminal with -mode=term, -pos is used to specify where to split the terminal window, it can be one of "tab", "curwin", "top", "bottom", "left", "right" and "external". And you can customize new runners and pass runner's name to -pos option. |
-rows=num | 0 | When using a horizontal split terminal, this value represents the height of terminal window. |
-cols=num | 0 | When using a vertical split terminal, this value represents the width of terminal window. |
-focus=? | 1 | set to 0 to prevent focus changing when -mode=term |
-hidden=? | 0 | set to 1 to init bufhidden to hide for internal terminal, set to 0 to init bufhidden to wipe |
-listed=? | 1 | when using -mode=term, set to 0 to hide the terminal in the buffer list |
-close | unset | when using -mode=term, close the terminal automatically when terminal process is finished |
For the full list of the options, please see the Command Specification.
All options must start with a minus and position before [cmd]. Since no shell command string starting with a minus. So they can be distinguished from shell command easily without any ambiguity.
Don't worry if you do have a shell command starting with '-', Just put a placeholder @ before your command to tell asyncrun explicitly: "stop parsing options now, the following string is all my command".
:AsyncStop[!]
stop the running job, when "!" is included, job will be stopped by signal KILL.
Function form is convenient for vimscript:
:call asyncrun#run(bang, opts, command)
parameters:
bang: an empty string or a single bang character "!", same as bang sign in AsyncRun!.opts: a dictionary contains: mode, cwd, raw and errorformat etc.command: the shell command you want to execute.&encoding, see encoding.For more information of above options, please visit option details.
autocmd User AsyncRunPre - triggered before executing
autocmd User AsyncRunStart - triggered after starting successfully
autocmd User AsyncRunStop - triggered when job finished
Note, AsyncRunPre is always likely to be invoked, but AsyncRunStart and AsyncRunStop will only be invoked if the job starts successfully.
When the previous job is still running or vim job slot is full, AsyncRun may fail. In this circumstance, AsyncRunPre will be invoked but AsyncRunStart and AsyncRunStop will have no chance to trigger.
Vim is lack of project management, as files usually belong to projects, you can do nothing to the project if you don't have any information about where the project locates. Inspired by CtrlP, this feature (new in version 1.3.12) is very useful when you've something to do with the whole project.
Macro <root> or $(VIM_ROOT) in the command line or in the -cwd option will be expanded as the Project Root Directory of the current file:
:AsyncRun make
:AsyncRun -cwd=<root> make
The first make will run in the vim's current directory (which :pwd returns), while the second one will run in the project root directory of current file. This feature is very useful when you have something (make / grep) to do with the whole project.
The project root is the nearest ancestor directory of the current file which contains one of these directories or files: .svn, .git, .hg, .root or .project. If none of the parent directories contains these root markers, the directory of the current file is used as the project root. The root markers can also be configurated, see Project Root.
The default behavior is to run async command and output to quickfix window. However there is a -mode=? option can allow you specify how to run your command:
| mode | description |
|---|---|
| async | default behavior, run async command and output to quickfix window |
| bang | same as ! |
| term | open a reusable internal terminal window and run your command |
For more information, please see here.
AsyncRun is capable to run commands in Vim/NeoVim's internal terminal with the -mode=term option. You can specify how to open the terminal window by -pos=?, available positions are:
-pos=tab: open the terminal in a new tab.-pos=TAB: open the terminal in a new tab on the left side.-pos=curwin: open the terminal in the current window.-pos=top: open the terminal above the current window.-pos=bottom: open the terminal below the current window.-pos=left: open the terminal on the left side.-pos=right: open the terminal on the right side.-pos=hide: don't open a window, run in background.-pos=external: use an external terminal (Windows & Gnome only).Examples:
:AsyncRun -mode=term -pos=tab python "$(VIM_FILEPATH)"
:AsyncRun -mode=term -pos=TAB -close -cwd=<root> lazygit
:AsyncRun -mode=term -pos=bottom -rows=10 python "$(VIM_FILEPATH)"
:AsyncRun -mode=term -pos=right -cols=80 python "$(VIM_FILEPATH)"
:AsyncRun -mode=term -pos=curwin python "$(VIM_FILEPATH)"
:AsyncRun -mode=term -pos=curwin -hidden python "$(VIM_FILEPATH)"
Internal terminal related options:
| Option | Default | Description |
|---|---|---|
-pos=? | "bottom" | When using internal terminal with -mode=term, -pos is used to specify where to split the terminal window, it can be one of "tab", "curwin", "top", "bottom", "left", "right" and "external". |
-rows=num | 0 | When using a horizontal split terminal, this value represents the height of terminal window. |
-cols=num | 0 | When using a vertical split terminal, this value represents the width of terminal window. |
-focus=? | 1 | set to 0 to prevent focus changing when -mode=term |
-close | unset | when using -mode=term, close the terminal automatically when terminal process is finished |
-hidden=? | 0 | set to 1 to setup bufhidden to hide for internal terminal |
-listed=? | 1 | when using -mode=term, set to 0 to hide the terminal in the buffer list |
The -pos field accepts an uppercase TAB, to create a tab on the left of the current tab. When using internal terminal in a split window, AsyncRun will firstly reuse a finished previous terminal window if it exists, if not, a new terminal window will be created in given position. Tab based terminal can also be reusable if -reuse is provided.
There can be many commands running in the internal terminal, you can specify a name for each of them and receive it in g:asyncrun_name:
:AsyncRun -mode=term -pos=hide -name=123 -post=echo\ g:asyncrun_name ls -la
When this process finished, script defined in -post will be executed and your command name will display by echo. Another variable g:asyncrun_code stores exit code.
AsyncRun displays its output in quickfix window, so if you don't use :copen {height} to open quickfix window, you won't see any output. For convenience there is an option g:asyncrun_open for you:
:let g:asyncrun_open = 8
Setting g:asyncrun_open to 8 will open quickfix window automatically at 8 lines height after command starts.
AsyncRun can take a range of lines in the current buffer as command's stdin after version 1.3.27. You can try:
:%AsyncRun cat
the whole buffer will be the input of command cat. you will see the content of your current buffer will be output to the quickfix window.
:10,20AsyncRun python
text between line 10-20 will be taken as the stdin of python. code in that range will be executed by python and the output will display in the quickfix window.
:'<,'>AsyncRun -raw perl
The visual selection (line-wise) will be taken as stdin.
AsyncRun provides enough flexibility and possibility to customize various details of how to run a command.
Besides the default quickfix and internal terminal mechanism, the user-defined runners allow you to run commands in any way you want. eg. in a new gnome-terminal window/tab, a floaterm window, or a side-by-side tmux split.
By default, AsyncRun is shipped with some popular runners:
| Runner | Description | Requirement | Link |
|---|---|---|---|
gnome | run in a new gnome terminal | GNOME | gnome.vim |
gnome_tab | run in a new gnome terminal tab | GNOME | gnome_tab.vim |
xterm | run in a xterm window | xterm | xterm.vim |
tmux | run in a separated tmux split | Vimux | tmux.vim |
floaterm | run in a new floaterm window | floaterm | floaterm.vim |
floaterm_reuse | run in a reusable floaterm window | floaterm | floaterm_reuse.vim |
quickui | run in a quickui window | vim-quickui | quickui.vim |
termhelp | run in terminal help | vim-terminal-help | termhelp.vim |
toggleterm | run in a toggleterm window | toggleterm.nvim | toggleterm.vim |
xfce | run in a new xfce terminal | xfce4-terminal | xfce.vim |
konsole | run in a new konsole terminal | KDE | konsole.vim |
macos | run in a macOS system terminal | macOS | macos.vim |
iterm | run in a new iTerm2 tab | macOS + iTerm2 | iterm.vim |
e.g.
:AsyncRun -mode=term -pos=gnome ls -la
:AsyncRun -mode=term -pos=floaterm ls -la
:AsyncRun -mode=term -pos=tmux ls -la
Screenshot for gnome runner:
When using gnome, konsole, or xfce runner in GVim, you get exactly the same experience like starting a command-line program from IDEs.
When you use toggleterm2 and use the packer.nvim management plugin, you can set shortcut keys to specify the open window, such as:
use({
"skywind3000/asyncrun.vim",
as = "asyncrun",
config = function()
require("asyncrun_toggleterm").setup({
mapping = "<leader>tt",
start_in_insert = false,
})
end,
})
All runners are customizable, you can modify or define your own runners, see the next section "customize runner".
User-defined runners allow you to specify how the command will run by creating a new runner. It can be useful when you want your commands run in a tmux split or a new gnome-terminal window:
function! MyRunner(opts)
echo "command to run is: " . a:opts.cmd
endfunction
let g:asyncrun_runner = get(g:, 'asyncrun_runner', {})
let g:asyncrun_runner.test = function('MyRunner')
Then try:
:AsyncRun -mode=term -pos=test ls -la $(VIM_FILEDIR)
When -mode is term and -pos can used to represent runner name.
Runner function has only one argument: opts, it contains the options extracted from :AsyncRun command line, and opts.cmd stores current command.
Another way to create a runner is to simply create a .vim file in the autoload/asyncrun/runner/ folder of your run-time-path (see the examples).
For more information, please visit project wiki: customize runner.
Command modifiers can be used to change your command before running:
let g:asyncrun_program = get(g:, 'asyncrun_program', {})
let g:asyncrun_program.nice = { opts -> 'nice -5' . opts.cmd }
When you are using:
:AsyncRun -program=nice ls -la
The command ls -la will be changed into nice -5 ls -la.
The -program=msys, -program=wsl are both implemented as a new command modifier it changes command ls into:
c:\windows\sysnative\wsl.exe ls
And replace any thing like $(WSL_FILENAME) and $(WSL_FILEPATH) in your command.
Vim 7.4.1829 is minimal version to support async mode. If you are use older versions, g:asyncrun_mode will fall back from 0/async to 1/sync. NeoVim 0.1.4 or later is also supported.
Recommend to use Vim 8.0 or later.
asyncrun.vim can cooperate with vim-fugitive, see here.
Don't forget to read the Frequently Asked Questions.
| Name | Description |
|---|---|
| asynctasks | Introduce vscode's task system to vim (powered by AsyncRun). |
| vim-fugitive | perfect cooperation, asyncrun gets Gfetch/Gpush running in background |
| errormarker | perfect cooperation, errormarker will display the signs on the error or warning lines |
| airline | very well, airline will display status of background jobs |
| sprint | nice plugin who uses asyncrun to provide an IDE's run button to runs your code |
See: Cooperate with famous plugins
-post can be used in terminal mode.-silent option to prevent open quickfix, add command modifier.g:asyncrun_program.:execute if command is starting with colon.g:asyncrun_runner, see customize runner.-safe=1, -listed=0 and -reuse.-hidden when using -mode=term to set bufhidden to hidden.-pos=curwin.-program=wsl to run command in wsl (windows 10 only).-pos=curwin to open terminal in current window.-focus=0 option for -mode=term to prevent focus change.-mode=term, omit number and signcolunm in terminal.errorformat in asyncrun#run(...).-mode=term to run command in a reusable terminal window.tcd (introduced in 8.1.1218). use grepformat when -program=grep.g:asyncrun_stdin because rg will break if stdin is pipe.g:asyncrun_stdin, set to 1 to enable stdin .$VIM_PATHNOEXT (by @PietroPate)-strip and -append option to control quickfix (by @bennyyip)g:asyncrun_save to save files.tcd command in neovim.:%AsyncRun catg:asyncrun_wrapper to enable setup a command prefix% and $* macros. close #96 #84 and #35g:asyncrun_open to open quickfix window automatically at given height.g:asyncrun_skip to skip specific autocmd.<root> or $(VIM_ROOT) to indicate project root directory.^M in NeoVim 2.0 on windowsTrying best to provide the most simply and convenience experience in the asynchronous-jobs.
Author: skywind3000 Please vote it if you like it: http://www.vim.org/scripts/script.php?script_id=5431
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.