Task Config

Get Started

A basic task sample looks like this:

# define a new task named "file-build"
[file-build]

# shell command, use quotation for filenames containing spaces
# check ":AsyncTaskMacro" to see available macros
command=gcc "$(VIM_FILEPATH)" -o "$(VIM_FILEDIR)/$(VIM_FILENOEXT)"

# working directory, can change to $(VIM_ROOT) for project root
cwd=$(VIM_FILEDIR)

# output mode, can be one of quickfix and terminal
# - quickfix: output to quickfix window
# - terminal: run the command in the internal terminal
output=quickfix

# this is for output=quickfix only
# if it is omitted, vim's current errorformat will be used.
errorformat=%f:%l:%m

# save file before execute
save=1

Options

Name	Required	Description
command	yes	shell command, or vimscript (starting with :)
cwd	no	working directory, vim's working directory will be used when absent
output	no	quickfix or terminal
pos	no	terminal position or the name of a runner. if not provided, g:asynctasks_term_pos will be used. use tab, TAB, bottom, top, left, right, and external for internal terminal position, or gnome, iterm, floaterm, and tmux for external runners. see extra runner