ConEmu GuiMacro

"%ConEmuBaseDir%\ConEmuC.exe" /GUIMACRO WindowMinimize
ConEmuC -GuiMacro palette 1 "<Solarized>" -guimacro WindowMaximize
ConEmuC -guimacro status 1 test
ConEmuC -Guimacro Flash(1,3,5) ; MsgBox("Notification text")
ConEmuC -GuiMacro:0 print: C:\Program Files (x86)\Adobe\Reader 10.0\Reader\AcroRd32

ConEmu.exe -Detached -GuiMacro "Create(0,1); Context; print(\"echo \\\"Hello world\\\"\");"

rem We need real ESC code (symbol with ASCII \x1B) in cmd scripts
call SetEscChar.cmd
echo %ESC%]9;6;"IsConEmu"%ESC%\
if "%ConEmuMacroResult%"=="Yes" echo ConEmu found!

F11 -> ConEmu -> Execute ConEmu macro

Plugin.SyncCall("4b675d80-1d4a-4ea9-8436-fdc23f2fc14b","IsConEmu()")

Plugin.Call("4b675d80-1d4a-4ea9-8436-fdc23f2fc14b","IsConEmu()")

callplugin(0x43454D55,"IsConEmu()")

Function(Arguments)

Function Arguments

Function: Arguments

print: C:\Program Files (x86)\Adobe\Reader 10.0\Reader\AcroRd32
  or
print("C:\\Program Files (x86)\\Adobe\Reader 10.0\\Reader\\AcroRd32")
  or
print(@"C:\Program Files (x86)\Adobe\Reader 10.0\Reader\AcroRd32")

Function(Arg1,Arg2,Arg3)

Function Arg1 Arg2 Arg3

print("abc"); keys("^_"); print("def")

ConEmuC -GuiMacro print abc -GuiMacro keys "^_" -GuiMacro print def

FontSetSize(1,-1)

MsgBox("Text","Title",0x132)

\\  --> \
\"  --> "
\r  --> Carriage return (ASCII 13)
\n  --> New line (ASCII 10)
\t  --> Horizontal tab (ASCII 9)
\b  --> Backspace (ASCII 8)
\e  --> Escape (ASCII 27)
\a  --> Alert (ASCII 7)

\x1B   --> same as \e (ASCII 27)
\x044F --> russian ‘я’ letter

print("\eCD /d \"C:\\Users\"\n")

print(@"CD /d ""C:\Users""")

Plugin.SyncCall("4b675d80-1d4a-4ea9-8436-fdc23f2fc14b","shell(\"new_console\",@\""..win.GetEnv("FARHOME").."\\far.exe\")")

ConEmuC [/SILENT] /GuiMacro[:PID|HWND][:T<tab>][:S<split>] <GuiMacro command>
  or
ConEmuC [-Silent] -GuiMacro[:PID|HWND][:T<tab>][:S<split>] <GuiMacro command>

ConEmuC -GuiMacro print abc

ConEmuC -GuiMacro:0 print: C:\Program Files (x86)\Adobe\Reader 10.0\Reader\AcroRd32
  or
ConEmuC -GuiMacro:8204 print "This is sample text"
  or
ConEmuC -GuiMacro:x140F32 WindowMinimize

ConEmu.exe -Detached -GuiMacro "Create(0,1); Context; print(\"echo \\\"Hello world\\\"\");"

Plugin.SyncCall("4b675d80-1d4a-4ea9-8436-fdc23f2fc14b","IsConEmu()")

Plugin.Call("4b675d80-1d4a-4ea9-8436-fdc23f2fc14b","IsConEmu()")

callplugin(0x43454D55,"IsConEmu()")

About(["<Page>"])
  - Show ‘About’ dialog with page activated, e.g. ‘About("-new_console")’

AltNumber([Base])
  - Start Alt+Numbers mode: Base = 10 or 16

AffinityPriority( *Affinity*, *Priority* )
  - Call without arguments to show affinity/priority dialog
    Affinity: Number - processor mask, same as WinApi's SetProcessAffinityMask
              "" - empty string means ‘don't change’
    Priority: Number - priority class, same as WinApi's SetPriorityClass
              "" - empty string means ‘don't change’

Attach([<PID>[,<Alternative>]])
  - Attach console or ChildGui by PID

Break([<Event>[,<ProcessGroupId>]])
  - Event==0: Generates a CTRL+C signal
    Event==1: Generates a CTRL+BREAK signal
    More info in GenerateConsoleCtrlEvent WinAPI function

Close(<What>[,<Flags>])
  - Close current console (0), without confirmation (0,1),
    terminate active process (1), without confirmation (1,1)
    close ConEmu window (2)
    close active tab (3)
    close active group (4)
    close all tabs but active (5)
    close active tab or group (6)
    close all active processes of the active group (7)
    close all tabs (8)

Context([<Tab>[,<Split>]])
  - Change macro execution context
    Tab: 1-based tab index
    Split: 1-based split index

Copy(<What>[,<Format>[,"<File>"]])
  - Copy active console contents
    What==0: current selection
    What==1: all buffer contents
    What==2: visible area contents
    Format==0: plain text, not formatting
    Format==1: copy HTML format
    Format==2: copy as HTML
    File: if specified - save to file instead of clipboard

Debug(<Action>)
  - Create debugger console or memory dumps
    Action==0: Debug active process
    Action==1: Active process memory dump
    Action==2: Active process tree memory dump

Detach
  - Detach active RealConsole from ConEmu

FindEditor("<FullEditFileName>"),
FindViewer("<FullViewerFileName>"),
FindFarWindow(<WindowType>,"<WindowTitle>")
 - Returns "Found:<index of RealConsole>", "Active:<Far window number>", "Blocked", or "NotFound"
   <WindowType> is number from Far Manager enum WINDOWINFO_TYPE

Flash(<Cmd>[,<Flags>[,<Count>]])
  - Allows to flash taskbar icon and/or window caption
    Flash(0) - Stop all flashing
    Flash(0,1) - Simple flashing (see MSDN FlashWindow)
Flash(1,<Flags>,<Count>)
  - Special flashing (see MSDN FlashWindowEx)
    Flags: 0 - stop, 1 - caption, 2 - taskbar, 3 - caption+taskbar, etc.
    Count: the number of times to flash the window

FontSetName("<FontFaceName>"[,FontHeight[,FontWidth]])
 - Change font face name and (optionally) height/width.

FontSetSize(Relative,N)
 - Change font height in the ConEmu window
   Relative==0: N - required font height in points
   Relative==1: N (+-1, +-2) - increase/decrease font height
   Relative==2: N (per cents) - alias for Zoom(N)
   returns - "OK", or "InvalidArg"

GetInfo("<Opt1>"[,"<Opt2>"[,...]])
  - Returns values of some ConEmu environment variables
    Processed in GUI so the result may differs from RealConsole env.vars
    "PID": %ConEmuPID% and so on
  - Returns additional information about RealConsole
    "Root": XML with RootProcess info
    "ActivePID","CurDir": as is

GetOption("<Name>")
 - Returns value of some ConEmu options (the set is limited)

GroupInput([<Cmd>])
 - Group keyboard input for visible splits
   Cmd==0: switch mode (default)
   Cmd==1: group
   Cmd==2: un-group

HighlightMouse(0)
 - Switch highlight under mouse cursor (off/row/col/row+col/...)
HighlightMouse(<What>,<Act>)
 - What: 1 - row, 2 - col, 3 - row+col
   Act:  0 - off, 1 - on,  2 - switch (default)

IsConEmu
 - Returns "Yes" when console was started under ConEmu
   Alternative is "ConEmuC.exe -IsConEmu" and checking errorlevel

IsConsoleActive
 - Check, is RealConsole active or not, "Yes"/"No"

IsRealVisible
 - Check, is RealConsole visible or not, "Yes"/"No"

Keys("<Combo1>"[,"<Combo2>"[,...]])
 - Post special keystrokes to the console (AutoHotKey syntax)
   "[Mod1[Mod2[Mod3]]]Key"
   Mod: ^ - LCtrl, >^ - RCtrl, ! - LAlt, >! - RAlt, + - Shift
   Example: Keys("^_") will post ‘Ctrl+_’

MsgBox("<Text>","<Title>",<ButtonType>)
 - Show modal GUI MessageBox, returns clicked button name
   ("Ok", "Cancel", "Retry", etc.),
   ButtonType (number) is from Windows SDK.

Palette([<Cmd>[,"<NewPalette>"|<NewPaletteIndex>]])
  - Returns current palette name, change if <Cmd> specified
     Cmd==0: return palette from ConEmu settings
     Cmd==1: change palette in ConEmu settings, returns prev palette
     Cmd==2: return palette from current console
     Cmd==3: change palette in current console, returns prev palette
     NewPalette: palette name (string)
     NewPaletteIndex: 0-based index (number)

Paste(<Cmd>[,"<Text>"[,"<Text2>"[...]]])
 - When <Text> is omitted - paste from Windows clipboard,
   otherwise - paste specified text
   Cmd==0: paste all lines
   Cmd==1: paste first line
   Cmd==2: paste all lines, without confirmations
   Cmd==3: paste first line, without confirmations
   Cmd==4: select and parse file pathname, Text - default
   Cmd==5: select and parse folder pathname, Text - default
   Cmd==6: select and parse cygwin file pathname, Text - default
   Cmd==7: select and parse cygwin folder pathname, Text - default
   Cmd==8: paste path from clipboard converted to CygWin style
   Cmd==9: paste all lines space-separated
   Cmd==10: paste all lines space-separated, without confirmations

PasteExplorerPath (<DoCd>,<SetFocus>)
  - Activate ConEmu and ‘CD’ to last (top in Z-order) Explorer window path
     DoCd: 1 - ‘CD’, 0 - paste path only
     SetFocus: 1 - bring ConEmu to the top, 0 - don't change active window

PasteFile(<Cmd>[,"<File>"[,"<CommentMark>"]])
 - Paste <File> contents, omit <File> to show selection dialog
   Cmd==0: paste all lines
   Cmd==1: paste first line
   Cmd==2: paste all lines, without confirmations
   Cmd==3: paste first line, without confirmations
   Cmd==9: paste all lines space-separated
   Cmd==10: paste all lines space-separated, without confirmations
   If "<CommentMark>" specified - skip all lines starting with prefix

Pause([<Cmd>])
  - Pause current console
     Cmd==0: switch mode (default)
     Cmd==1: pause
     Cmd==2: un-pause

Print(["<Text>"[,"<Text2>"[...]]])
 - Alias for Paste(2,"<Text>")

Progress(<Type>[,<Value>])
 - Set progress state on taskbar and ConEmu title
   Type=0: remove progress
   Type=1: set progress value to <Value> (0-100)
   Type=2: set error state in progress with <Value>
   Type=3: set indeterminate state in progress
   Type=4: set paused state in progress with <Value>

Recreate(<Action>[,<Confirm>[,<AsAdmin>]]), alias "Create"
 - Create new tab or restart existing one
    Action: 0 - create tab, 1 - restart tab, 2 - create window
    Confirm: 1 - show ‘Create new console’ dialog, 0 - don't show
    AsAdmin: 1 - start elevated tab

Rename(<Type>,["<Title>"])
 - Rename tab (Type=0) or console title (Type=1)

Scroll(<Type>,<Direction>,<Count=1>)
 - Do buffer scrolling actions
   Type: 0; Value: ‘-1’=Up, ‘+1’=Down
   Type: 1; Value: ‘-1’=PgUp, ‘+1’=PgDown
   Type: 2; Value: ‘-1’=HalfPgUp, ‘+1’=HalfPgDown
   Type: 3; Value: ‘-1’=Top, ‘+1’=Bottom
   Type: 4; No arguments; Go to cursor line

Select(<Type>,<DX>,<DY>,<HE>)
 - Used internally for text selection
   Type: 0 - Text, 1 - Block, 2 - Stop
   DX: select text horizontally: -1/+1
   DY: select text vertically: -1/+1
   HE: to-home(-1)/to-end(+1) with text selection
   HE: word-left(-2)/word-right(+2) with text selection
Select(2)
 - Use to cancel active selection

SetDpi(<DPI>)
 - Change effective dpi for ConEmu window: 96, 120, 144, 192

SetFocus(<Type>)
 - Try to change active window
   Type: 0 - Set focus into ConEmu window/process (default)
   Type: 1 - Switch focus between ConEmu and ChildGui
   Type: 2 - Set focus into ChildGui window of the active console
   Type: 3 - Set focus into the parent of the ConEmu window (ConEmu Inside mode)

SetOption("Check",<ID>,<Value>)
   ID: numeric identifier of checkbox (ConEmu.rc, resource.h)
   Value: 0 - off, 1 - on, 2 - third state
   Read about SetOption below

SetOption("<Name>",<Value>[,<IsRelative>])
 - Name=one of allowed for changing ConEmu options
   IsRelative=1 to use relative instead of absolute for some options
   "AlphaValue": set transparency level of active window
     Value: 40 .. 255 (255==Opaque)
   "AlphaValueInactive": set transparency level of inactive window
     Value: 0 .. 255 (255==Opaque)
   "AlphaValueSeparate": enable separate active/inactive transparency level
     Value: 0(disable) .. 1(enable)
   "AlwaysOnTop": place ConEmu window above all non-topmost windows
     Value: 2 - toggle, 1 - enable, 0 - disable
   "bgImage": change background image
      Value: file or color, e.g. "C:\image.jpg" or "#3182a4"
   "bgImageDarker": darkening of background image
     Value: 0 .. 255
   "FarGotoEditorPath": path to the highlight/error editor
     Value: path to the executable with arguments (Issue 1704)
   "QuakeAutoHide": auto hide on focus lose, Quake mode
     Value: 2 - switch auto-hide, 1 - enable, 0 - disable

SetParentHWND(<HWND>)
 - Change ConEmu parent window during Inside mode
   HWND: new parent window handle

Settings([<PageResourceId>])
 - Show ‘Settings’ dialog with specified page activated (optionally)
     PageResourceId: integer DialogID from ‘resource.h’

Shell("<Verb>","<File>"[,"<Parms>"[,"<Dir>"[,<ShowCmd>]]])
 - Verb can be "open", "print" and so on, or special value "new_console",
   which starts File in the new tab of ConEmu window. Examples:
     Shell("open","cmd.exe","/k")
     Shell("","","cmd.exe /k -new_console:b"),
     Shell("new_console:b","","cmd.exe /k")
     Shell("new_console:sV")
     Shell("new_console:Ibn","cmd","/k start explorer \"%CD%\" && exit")

Sleep(<Milliseconds>)
 - Milliseconds: max 10000 (10 seconds)

Split(<Cmd>,<Horz>,<Vert>)
 - Cmd=0, Horz=1..99, Vert=0: Duplicate active ‘shell’ split to right, same as Shell("new_console:s50Hn")
   Cmd=0, Horz=0, Vert=1..99: Duplicate active ‘shell’ split to bottom, same as Shell("new_console:s50Vn")
   Cmd=1, Horz=-1..1, Vert=-1..1: Move splitter between panes (aka resize panes)
   Cmd=2, Horz=-1..1, Vert=-1..1: Put cursor to the nearest pane (preferred direction may be choosed)
   Cmd=3, Maximize/restore active pane

Status(0[,<Parm>])
 - Show/Hide status bar, Parm=1 - Show, Parm=2 - Hide
Status(1[,"<Text>"])
 - Set status bar text

Tab(<Cmd>[,<Parm>])
 - Control ConEmu tabs
   Cmd==0:  show/hide tabs
   Cmd==1:  commit lazy changes
   Cmd==2:  switch next (eq. CtrlTab)
   Cmd==3:  switch prev (eq. CtrlShiftTab)
   Cmd==4:  switch tab direct (no recent mode), Parm=(1,-1)
   Cmd==5:  switch tab recent, Parm=(1,-1)
   Cmd==6:  switch console direct (no recent mode), Parm=(1,-1)
   Cmd==7:  activate console, Parm=(1-based console index, -1 for the last tab, -2 for the tab of execution)
   Cmd==8:  show tabs list menu (indiffirent Far/Not Far)
   Cmd==9:  close active tab, same as Close(3)
   Cmd==10: switches visible split-panes, Parm=(1,-1)
   Cmd==11: activates tab by name, title or process name
   Cmd==12: return tabs list "1: tab1\n2: tab2\n..."

Task(Index[,"Dir"])
 - start task with 1-based index
Task("Name"[,"Dir"])
 - start task with specified name

TaskAdd("Name","Commands"[,"GuiArgs"[,Flags]])
 - create new task and save it to settings

TermMode(<Mode>[,<Action>])
  - changes active terminal modes
    Mode==0: Keyboard emulation (Xterm/Windows)
    Mode==1: Bracketed paste
    Mode==2: Application cursor keys (DECCKM)
    Action==0: Disable mode
    Action==1: Enable mode
    Action==2: Switch mode (default)

Transparency(<Cmd>,<Value>)
 - Change ConEmu window transparency level
   Cmd = 0, Value = 40..255 (255==Opaque)
   Cmd = 1, Value = <relative inc/dec>
   Cmd = 2, Value = 0..255 (255==Opaque) - for inactive window
   Cmd = 3, Value = <relative inc/dec> - for inactive window
   Cmd = 4, Value = <0/1> - AlphaValueSeparate

Wiki(["PageName"])
 - Open online documentation

WindowFullscreen()
 - Switch fullscreen window mode
   returns previous window mode
WindowMaximize([<Cmd>])
 - Switch maximized window mode (Cmd==0)
 - Maximize window by width (Cmd==1) or height (Cmd==2)
   returns previous window mode
WindowMinimize() or WindowMinimize(1)
 - Minimize ConEmu window ("1" means "minimize to the TSA")
WindowMode(["<Mode>"])
 - Returns or set current window mode
   "NOR", "MAX", "FS" (fullscreen), "MIN", "TSA"
   "TLEFT", "TRIGHT" (tile to left/right),
   "THEIGHT", "TWIDTH" (tile/maximize height/width),
   "MPREV", "MNEXT" (move ConEmu to prev/next monitor)
   "HERE" (move ConEmu to monitor with mouse cursor)

WindowPosSize("<X>", "<Y>", "<W>", "<H>")
  - Change ConEmu window geometry
    "<X>" and "<Y>" are pixels (numbers in doublequotes);
    "<W>" and "<H>" may be cells, percentage or pixels:
      "80", "40%", "800px".

Write("<Text>")
  - Write text to console OUTPUT

Write "\e7\e[90mEcho \"Hello world!\"\e[m\e8"

Write "\n\n\e[91m========== '\e]9;8;\"time\"\e\\' ==========\e[m\n\n"

Zoom(N)
 - Set zoom value, 100 - original font size

SetOption("FarGotoEditorPath","far.exe /e%1:%2 \"%3\"")

ConEmuC -GuiMacro SetOption Check 2488 1

ConEmuC -GuiMacro SetOption Check 2333 0

local conemu = "4B675D80-1D4A-4EA9-8436-FDC23F2FC14B"

if Plugin.SyncCall(conemu,"IsConEmu")=="Yes" then
  far.Message("Far started under ConEmu","Macro")
end

local cmd = ('shell("open",@"%s")'):format(win.GetEnv"FARHOME"..[[\Encyclopedia\FarEncyclopedia.ru.chm]])
Plugin.SyncCall(conemu,cmd)

local cmd = ('shell("new_console",@"%s")'):format(win.GetEnv"FARHOME".."\\far.exe")
Plugin.SyncCall(conemu,cmd)

$if (callplugin("4b675d80-1d4a-4ea9-8436-fdc23f2fc14b","IsConEmu()")!=0 && env("ConEmuMacroResult")=="Yes")
  MsgBox("Macro", "Far started under ConEmu")
$end

callplugin("4b675d80-1d4a-4ea9-8436-fdc23f2fc14b","shell(\"open\",@\""+env("FARHOME")+"\\Encyclopedia\\FarEncyclopedia.ru.chm\")")

callplugin("4b675d80-1d4a-4ea9-8436-fdc23f2fc14b","shell(\"new_console\",@\""+env("FARHOME")+"\\far.exe\")")

$if (callplugin(0x43454D55,"IsConEmu()")!=0 && env("ConEmuMacroResult")=="Yes")
  MsgBox("Macro", "Far started under ConEmu")
$end

F11
$if (menu.Select("ConEmu",2)<=0) MsgBox("ConEmu","Plugin was not found in list!",1)
  $Exit
$end
Enter %r="";
$if (menu.select("~.",1)>0)
  ~ $Text "IsConEmu()" Enter %r=Dlg.GetValue(5,0);
$end
Esc
$if (%r=="Yes")
  MsgBox("Macro", "Far started under ConEmu")
$end