Skip to main content

How to Get the Current Username in Batch Script

Knowing the identity of the user running a script is fundamental for personalization, logging, and security. A script might need the current username to access the user's profile directory, write to a user-specific log file, or display a personalized greeting. Windows provides a simple and reliable, built-in environment variable for this exact purpose.

This guide will teach you the standard and most direct way to get the current user's name using the %USERNAME% variable. We will also cover the whoami command as a robust alternative and show a practical example of how to use this information to create a user-specific data folder.

Core Method: The %USERNAME% Variable​

The simplest, fastest, and most common way to get the name of the currently logged-in user is by using the built-in %USERNAME% environment variable. This variable is set by the system when the user logs in and is always available in any command prompt session.

Because it's a variable, you can use it directly in your commands without needing to run any external programs. This makes it the most efficient and highly recommended method.

Alternative Method: The whoami Command​

Windows also includes a command-line utility called whoami.exe. Its primary purpose is to display the user context in which the current process is running.

Command: whoami

When run without any switches, whoami returns the username in the format domain\user (or computername\user for local accounts).

While whoami is very reliable, it is slightly less efficient for scripting than %USERNAME% because it requires running an external program. You must use a FOR /F loop to capture its output.

Basic Example: Displaying the Current User​

This script demonstrates both methods for getting the username.

@ECHO OFF
ECHO --- Getting the Current User ---
ECHO.

ECHO Method 1 (Recommended): Using the %%USERNAME%% variable
ECHO The username is: %USERNAME%

ECHO.

ECHO Method 2: Using the 'whoami' command
whoami

Notice the slight difference in format between the two outputs.

--- Getting the Current User ---

Method 1 (Recommended): Using the %%USERNAME%% variable
The username is: Admin

Method 2: Using the 'whoami' command
my-pc\admin
note

For most tasks, the simple name from %USERNAME% is what you need.

Storing the Name in a Variable​

In a script, you'll often want to store the name in another variable for clarity or to build a string.

  • With %USERNAME%: This is a simple, direct assignment.
  • With whoami: This requires a FOR /F loop to capture the command's output.
@ECHO OFF
SETLOCAL

REM --- Method 1: Direct assignment (Recommended) ---
SET "CurrentUser_Var=%USERNAME%"
ECHO From variable: %CurrentUser_Var%


REM --- Method 2: Capturing command output ---
SET "CurrentUser_Cmd="
FOR /F "delims=" %%U IN ('whoami') DO (
    SET "CurrentUser_Cmd=%%U"
)
ECHO From command:  %CurrentUser_Cmd%

ENDLOCAL

Common Pitfalls and How to Solve Them​

Getting the username is a very reliable operation with few pitfalls. The main considerations are context and format.

  • System vs. User Context: If your script is run as a Scheduled Task under the "SYSTEM" account, %USERNAME% will return the name of the computer followed by a $ (e.g., MY-PC$), and whoami will return nt authority\system. Be aware of the context in which your script will run.

  • Domain vs. Local: As seen in the example, whoami includes the domain or computer name. If you need to strip this prefix, you can use a FOR /F loop with a \ delimiter.

    FOR /F "tokens=2 delims=\" %%U IN ('whoami') DO SET "CleanUser=%%U"

Practical Example: Creating a User-Specific Application Folder​

This is a classic use case for a logon script or a first-run application setup. The script creates a dedicated data folder for the application inside the current user's AppData directory.

@ECHO OFF
SETLOCAL

REM --- Configuration ---
SET "AppName=MyCoolApp"

REM --- Build the path using the APPDATA and USERNAME variables ---
REM %APPDATA% expands to C:\Users\YourUser\AppData\Roaming
SET "AppDataPath=%APPDATA%\%AppName%\"
SET "UserLogFile=%AppDataPath%%USERNAME%_log.txt"

ECHO --- Application First-Run Setup ---
ECHO.
ECHO This script will create a user-specific folder at:
ECHO "%AppDataPath%"
ECHO.

REM --- Use IF NOT EXIST to safely create the directory ---
IF NOT EXIST "%AppDataPath%" (
    MKDIR "%AppDataPath%"
    ECHO Folder created.
) ELSE (
    ECHO Folder already exists.
)

ECHO Creating a user-specific log file...
ECHO User %USERNAME% ran the setup at %DATE% %TIME%. > "%UserLogFile%"

ECHO.
ECHO [SUCCESS] Setup complete.

ENDLOCAL

Conclusion​

Getting the current user's name is a simple but essential task for creating personalized and context-aware scripts.

  • The %USERNAME% environment variable is the standard, most efficient, and highly recommended method. It provides the simple username directly.
  • The whoami command is a robust alternative that provides the fully qualified name (domain\user), which can be useful in certain network environments.

For its simplicity and directness, you should always default to using the %USERNAME% variable in your batch scripts.

Table of Contents