Batch Files

When to Use This Skill

• Creating or editing

  .bat

  or

  .cmd

  files
• Automating Windows tasks (file operations, deployments, backups)
• Building CLI tools intended for a

  bin/

  folder on PATH
• Writing scheduled task scripts (SCHTASKS, Task Scheduler)
• Debugging batch script issues (variable expansion, error levels, quoting)
• Integrating batch scripts with external tools (curl, git, Node.js, Python)
• Scaffolding new batch-based projects with structured templates

Prerequisites

• Windows NT-based OS (Windows 7 or later)
• cmd.exe (built-in)
• Optional: a

  bin/

  directory on PATH for distributing scripts as commands
• Optional: PATHEXT configured to include

  .BAT;.CMD

  (default on Windows)

Command Interpretation

1. Variable substitution —

   %VAR%

   tokens are replaced with environment variable values.

   %0

   –

   %9

   reference batch arguments.

   %*

   expands to all arguments.
2. Quoting and escaping — Caret

   ^

   escapes special characters (

   & | < > ^

   ). Quotation marks prevent interpretation of enclosed special characters. In batch files,

   %%

   yields a literal

   %

   .
3. Syntax parsing — Lines are split into pipelines (

   |

   ), compound commands (

   &

   ,

   &&

   ,

   ||

   ), and parenthesized groups

   ( )

   .
4. Redirection —

   >

   overwrites,

   >>

   appends,

   <

   reads input,

   2>

   redirects stderr,

   2>&1

   merges stderr into stdout,

   >NUL

   discards output.

Variables

Environment Variables

set _MY_VAR=Hello World
echo %_MY_VAR%
set _MY_VAR=

• set

  with no arguments lists all variables

• set _PREFIX

  lists variables starting with

  _PREFIX

• No spaces around

  =

  —

  set name = val

  sets variable

  "name "

  to

  " val"

Special Variables

%CD%

%DATE%

%TIME%

%RANDOM%

%ERRORLEVEL%

%USERNAME%

%USERPROFILE%

%TEMP%

%TMP%

%PATHEXT%

%COMSPEC%

Scoping with SETLOCAL / ENDLOCAL

setlocal
set _LOCAL_VAR=scoped value
endlocal
REM _LOCAL_VAR is no longer defined here

endlocal & set _RESULT=%_LOCAL_VAR%

Delayed Expansion

setlocal EnableDelayedExpansion
set _COUNT=0
for /l %%i in (1,1,5) do (
    set /a _COUNT+=1
    echo !_COUNT!
)
endlocal

• !VAR!

  expands at execution time (delayed)

• %VAR%

  expands at parse time (immediate)

Control Flow

Conditional Execution

if exist "output.txt" echo File found
if not defined _MY_VAR echo Variable not set
if "%_STATUS%"=="ready" (echo Go) else (echo Wait)
if %ERRORLEVEL% neq 0 echo Command failed

equ

neq

lss

leq

gtr

geq

/i

Compound Commands

command1 & command2        & REM Always run both
command1 && command2       & REM Run command2 only if command1 succeeds
command1 || command2       & REM Run command2 only if command1 fails

FOR Loops

REM Iterate over a set of values
for %%i in (alpha beta gamma) do echo %%i

REM Numeric range: start, step, end
for /l %%i in (1,1,10) do echo %%i

REM Files in a directory
for %%f in (*.txt) do echo %%f

REM Recursive file search
for /r %%f in (*.log) do echo %%f

REM Directories only
for /d %%d in (*) do echo %%d

REM Parse command output
for /f "tokens=1,2 delims=:" %%a in ('ipconfig ^| findstr "IPv4"') do echo %%b

REM Parse file lines
for /f "usebackq tokens=*" %%a in ("data.txt") do echo %%a

GOTO and Labels

goto :main_logic
:usage
echo Usage: %~nx0 [options]
exit /b 1

:main_logic
echo Running main logic...
goto :eof

goto :eof

:

Command-Line Arguments

%0

%1

%9

%*

%~1

%~f1

%~d1

%~p1

%~n1

%~x1

%~dp0

%~nx0

%~z1

%~$PATH:1

Argument Parsing Pattern

:parse_args
if "%~1"=="" goto :args_done
if /i "%~1"=="--help" goto :usage
if /i "%~1"=="--output" (
    set "_OUTPUT_DIR=%~2"
    shift
)
shift
goto :parse_args
:args_done

String Processing

Substrings

set _STR=Hello World
echo %_STR:~0,5%       & REM "Hello"
echo %_STR:~6%         & REM "World"
echo %_STR:~-5%        & REM "World"
echo %_STR:~0,-6%      & REM "Hello"

Search and Replace

set _STR=Hello World
echo %_STR:World=Earth%       & REM "Hello Earth"
echo %_STR:Hello=%            & REM " World" (remove "Hello")

Substring Containment Test

if not "%_STR:World=%"=="%_STR%" echo Contains "World"

Functions

@echo off
call :greet "Jane Doe"
echo Result: %_GREETING%
exit /b 0

:greet
setlocal
set "_MSG=Hello, %~1"
endlocal & set "_GREETING=%_MSG%"
exit /b 0

• call :label args

  invokes a function

• exit /b

  returns from the function (not the script)
• Use the

  endlocal & set

  trick to pass values out of a scoped block

Arithmetic

set /a

set /a _RESULT=10 * 5 + 3
set /a _COUNTER+=1
set /a _REMAINDER=14 %% 3       & REM Use %% for modulo in batch files
set /a _BITS="255 & 0x0F"       & REM Bitwise AND

+ - * / %% ( )

& | ^ ~ << >>

0xFF

077

Error Handling

Error Level Conventions

• 0

  = success
• Non-zero = failure (typically

  1

  )

mycommand.exe
if %ERRORLEVEL% neq 0 (
    echo ERROR: mycommand failed with code %ERRORLEVEL%
    exit /b %ERRORLEVEL%
)

Fail-Fast Pattern

command1 || (echo command1 failed & exit /b 1)
command2 || (echo command2 failed & exit /b 1)

Setting Exit Codes

exit /b 0        & REM Return success from a batch/function
exit /b 1        & REM Return failure
cmd /c "exit /b 42"   & REM Set ERRORLEVEL to 42 inline

Essential Commands Reference

File Operations

DIR

COPY

XCOPY

ROBOCOPY

MOVE

DEL

REN

MD

MKDIR

RD

RMDIR

MKLINK

ATTRIB

TYPE

MORE

TREE

REPLACE

COMPACT

EXPAND

MAKECAB

TAR

Text Search and Processing

FIND

FINDSTR

SORT

CLIP

FC

COMP

CERTUTIL

System Information

SYSTEMINFO

HOSTNAME

VER

WHOAMI

TASKLIST

TASKKILL

WMIC

SC

DRIVERQUERY

REG

SETX

Network

PING

IPCONFIG

NSLOOKUP

NETSTAT

TRACERT

NET USE

NET USER

NETSH

ARP

ROUTE

CURL

SSH

Scheduling and Automation

SCHTASKS

TIMEOUT

START

RUNAS

SHUTDOWN

FORFILES

Shell Utilities

WHERE

DOSKEY

CHOICE

MODE

SUBST

CHCP

COLOR

TITLE

ASSOC

FTYPE

Shell Syntax and Expressions

Parentheses for Grouping

(echo Line 1 & echo Line 2) > output.txt
if exist "data.csv" (
    echo Processing...
    call :process "data.csv"
) else (
    echo No data found.
)

Escape Characters

^

echo Total ^& Summary          & REM Outputs: Total & Summary
echo 100%% complete            & REM Outputs: 100% complete (in batch)
echo Line one^
Line two                       & REM Caret escapes the newline

echo x ^^^& y | findstr x

Wildcards

• *

  matches any sequence of characters

• ?

  matches a single character (or zero at end of period-free segment)

dir *.txt           & REM All .txt files
ren *.jpeg *.jpg    & REM Bulk rename

Redirection Summary

command > file.txt          & REM Overwrite stdout to file
command >> file.txt         & REM Append stdout to file
command 2> errors.log       & REM Redirect stderr
command > all.log 2>&1      & REM Merge stderr into stdout
command < input.txt         & REM Read stdin from file
command > NUL 2>&1          & REM Discard all output

Writing Production-Quality Batch Files

Standard Script Structure

@echo off
setlocal EnableDelayedExpansion

REM ============================================================
REM  Script: example.bat
REM  Purpose: Describe what this script does
REM ============================================================

call :main %*
exit /b %ERRORLEVEL%

:main
    call :parse_args %*
    if not defined _TARGET (
        echo ERROR: --target is required. 1>&2
        call :usage
        exit /b 1
    )
    echo Processing: %_TARGET%
    exit /b 0

:parse_args
    if "%~1"=="" exit /b 0
    if /i "%~1"=="--target" set "_TARGET=%~2" & shift
    if /i "%~1"=="--help"   call :usage & exit /b 0
    shift
    goto :parse_args

:usage
    echo Usage: %~nx0 --target ^<path^> [--help]
    echo.
    echo Options:
    echo   --target   Path to process (required)
    echo   --help     Show this help message
    exit /b 0

Best Practices

1. Always start with

   @echo off

   and

   setlocal

   — Prevents noisy output and variable leakage to the caller.
2. Validate inputs before processing — Check required arguments and file existence early. Use

   if not defined

   and

   if not exist

   .
3. Quote paths and variables — Use

   "%~1"

   and

   "%_MY_PATH%"

   to handle spaces and special characters safely.
4. Use

   exit /b

   instead of

   exit

   — Avoids closing the parent console window.
5. Return meaningful exit codes —

   exit /b 0

   for success, non-zero for specific failures.
6. Use

   %~dp0

   for script-relative paths — Ensures the script works regardless of the caller's working directory.
7. Prefer

   ROBOCOPY

   over

   XCOPY

   — More reliable, supports retry, mirroring, and logging.
8. Use

   EnableDelayedExpansion

   when modifying variables inside loops or parenthesized blocks.
9. Write errors to stderr —

   echo ERROR: message 1>&2

   keeps stdout clean for piping.
10. Use

    REM

    for comments —

    ::

    can cause issues inside

    FOR

    loop bodies.

Security Considerations

• Never store credentials in batch files — Use environment variables, credential stores, or prompts.
• Validate user input — Unquoted variables containing

  &

  ,

  |

  , or

  >

  can inject commands. Always quote:

  "%_USER_INPUT%"

  .
• Use

  SETLOCAL

  — Prevents variable values from leaking to parent processes.
• Sanitize file paths — Validate paths before passing to

  DEL

  ,

  RD

  , or

  ROBOCOPY

  to prevent unintended deletion.
• Avoid

  SET /P

  for sensitive input — Input is visible and stored in console history. Use a dedicated credential tool when possible.

Debugging and Troubleshooting

@echo off

@echo on

PAUSE

echo Exit code: %ERRORLEVEL%

set _MY_

_MY_

( )

!VAR!

%%

%

%%i

%i

set name=value

set name = value

^^^

^(

^)

if

set /a r=14 %% 3

Cross-Platform and Extended Tools

CMD Keyboard Shortcuts

Tab

Up

Down

F7

F3

Esc

Ctrl+C

Alt+F7

Reference Files

references/

tools-and-resources.md

batch-files-and-functions.md

windows-commands.md

cygwin.md

msys2.md

windows-subsystem-on-linux.md

Asset Templates

assets/

executable.txt

library.txt

task.txt