Reference to Visual Studio code variables (2023)

Visual Studio Code supports variable substitution indebuggingmiHomeworkconfiguration files, as well as some selected settings. Variable substitution within some key-value strings is supported inlaunch.jsonmitasks.jsonfiles using${variablename}syntax.

predefined variables

The following predefined variables are supported:

  • ${homeuser}- the path of the user's home folder
  • ${workbook}- the path of the open folder in VS Code
  • ${workspaceFolderBasename}- the name of the open folder in VS Code without any slashes (/)
  • ${file}- the current open file
  • ${archive workspace folder}- the workspace folder of the current open file
  • ${relative file}- the current file opened relative toworkspacePasta
  • ${relativeFileDirname}- the directory name of the current open file relative toworkspacePasta
  • ${basefileName}- the base name of the current open file
  • ${baseFileNameWithoutExtension}- the base name of the current open file without file extension
  • ${archivoExtname}- the extension of the current open file
  • ${archivoDirname}- the folder path of the current open file
  • ${fileDirNameBaseName}- the folder name of the current open file
  • ${cwd}- the current working directory of the task runner at VS Code startup
  • ${line number}- the number of the currently selected line in the active file
  • ${selected text}- the currently selected text in the active file
  • ${ejecRoute}- the path to the running VS Code executable
  • ${defaultBuildTask}- the name of the default build task
  • ${pathSeparator}- the character used by the operating system to separate components into file paths

Examples of predefined variables

Assuming you have the following requirements:

  1. A file located at/home/tu-nombre-de-usuario/tu-proyecto/carpeta/archivo.extopen in your editor;
  2. the directory/home/your-user/your-projectopen as your root workspace.

Then you will have the following values ​​for each variable:

  • ${homeuser}-/home/your-user
  • ${workbook}-/home/your-user/your-project
  • ${workspaceFolderBasename}-your project
  • ${file}-/home/tu-nombre-de-usuario/tu-proyecto/carpeta/archivo.ext
  • ${archive workspace folder}-/home/your-user/your-project
  • ${relative file}-folder/file.ext
  • ${relativeFileDirname}-pasta
  • ${basefileName}-file.ext
  • ${baseFileNameWithoutExtension}-Archive
  • ${archivoDirname}-/home/your-user/your-project/folder
  • ${archivoExtname}-.ext
  • ${line number}- cursor line number
  • ${selected text}- selected text in your code editor
  • ${ejecRoute}- location of code.exe
  • ${pathSeparator}-/on macOS or Linux,\no windows

Advice: Use IntelliSense inside string values ​​totasks.jsonmilaunch.jsonfor a full list of predefined variables.

(Video) Navigating your code in VS Code — Symbols, definitions, references, navigation, and more!

Variables at workspace folder scope

By adding the root folder name to a variable (separated by a colon), you can access the sibling root folders of a workspace. Without the root folder name, the variable is limited to the same folder in which it is used.

For example, in a multiroot workspace with foldersservermiClient, and${work folder:client}refers to the wayClientfuente.

environmental variables

You can also reference environment variables via the${environment:Name}syntax (for example,${env:USERNAME}).

{ "writes":"that", "application":"launch", "Name":"Launch Program", "program":"${workspace folder}/app.js", "cwd":"${workbook}", "arg": ["${env:USERNAME}"]}

configuration variables

You can view VS Code's settings ("settings") via${config:Name}syntax (for example,${config:editor.fontSize}).

command variables

If the predefined variables above are not enough, you can use any VS Code command as a variable via the${command:commandID}syntax.

A command variable is replaced by the result (string) of the command evaluation. The implementation of a command can range from a simple computation with no UI to some sophisticated functionality based on the UI functions available through the VS Code extension API. If the command returns anything other than a string, the variable substitution will not complete. command variableshe mustreturn a string.

An example of this functionality is in the VS Code Node.js debugger extension, which provides an interactive commandextension.pickNodeProcessto select a single process from the list of all running Node.js processes. The command returns the ID of the selected process. This makes it possible to use theextension.pickNodeProcesscommand in oneAttach by process IDstart the configuration as follows:

(Video) How to show environment variables on terminal in Visual Studio Code (VS Code)

{ "settings": [{ "writes":"that", "application":"to attach", "Name":"Attach by process ID", "process identification":"${command:extension.pickNodeProcess}"}]}

When a command variable is used in alaunch.jsonconfiguration, attachmentlaunch.jsonthe configuration is passed as an object to the command via an argument. This allows the commands to know the context and parameters of thelaunch.jsonconfiguration when they are called.

input variables

Command variables are already powerful, but they lack a mechanism to configure the command that is executed for a specific use case. For example, it is not possible to pass awarning messageof unostandard valueto a generic "user input prompt".

This limitation is solved withinput variablesI have the syntax:${input:variableID}. oID de variablerefers to entries inAppetizerSection fromlaunch.jsonmitasks.json, where additional configuration attributes are specified. Nesting of input variables is not supported.

The following example shows the general structure of atasks.jsonwhich makes use of input variables:

{ "version":"2.0.0", "Chores": [{ "label":"name of the homework", "domain":"${input:variableID}" // ...}], "Appetizer": [{ "I would go":"IDvariable", "writes":"input variable type" // enter specific configuration attributes}]}

VS Code currently supports three types of input variables:

  • indicatorchain: Displays an input box to get a string from the user.
  • chooseString– Displays a quick select dropdown menu to allow the user to select from multiple options.
  • domain: Execute an arbitrary command.

Each type requires additional configuration attributes:


(Video) Intro to VSCode for C# Developers - From Installation to Debugging

  • Description: Displayed in quick input, provides context for the input.
  • model: Default value to be used if nothing else is entered by the user.
  • password: Set to true to enter with a password prompt that will not display the entered value.


  • Description: Displayed in the quick select, provides context for the input.
  • options: An array of options for the user to choose from.
  • model: Default value to be used if nothing else is entered by the user. Must be one of the option values.

An option can be a string value or an object with a label and a value. The dropdown menu will appearlabel: value.


  • domain: Command in execution in interpolation of variables.
  • arguments: Optional bag of options passed to the command implementation.

Below is an example oftasks.jsonwhich illustrates the use ofAppetizerusing the angular CLI:

{ "version":"2.0.0", "Chores": [{ "label":"deg", "writes":"Concha", "domain":"of", "arg": ["gram","${input: component type}","${input: component name}"]}], "Appetizer": [{ "writes":"choose string", "I would go":"component type", "Description":"What type of component do you want to create?", "options": [ "component", "directive", "tube", "Service", "class", "Guardia", "Interface", "enumeration"], "Preset":"component"},{ "writes":"request string", "I would go":"Component name", "Description":"Name your component.", "Preset":"my-new-component"}]}

Running the example:

Reference to Visual Studio code variables (1)

The following example shows how to use a user input variable of typedomainin a debug configuration that allows the user to choose a test case from a list of all test cases found in a specific folder. Some extension is supposed to provide aextension.mochaSupport.testPickercommand that places all test cases in a configurable location and displays a selection UI to choose one of them. The arguments for a command input are defined by the command itself.

(Video) Reference environment variables in your app.json with Jovo v1

{ "settings": [{ "writes":"that", "application":"launch", "Name":"Run specific test", "program":"${workspace folder}/${input: selection test}"}], "Appetizer": [{ "I would go":"choice test", "writes":"domain", "domain":"extension.mochaSupport.testPicker", "arg": { "test paste":"/output/tests"}}]}

Command inputs can also be used with tasks. In this example, the built-in End Task command is used. You can accept an argument to terminate all tasks.

{ "version":"2.0.0", "Chores": [{ "label":"Finish all tasks", "domain":"echo ${input: terminate}", "writes":"Concha", "troublesome correspondent": []}], "Appetizer": [{ "I would go":"end up", "writes":"domain", "domain":"workbench.action.tasks.finish", "arg":"finishAll"}]}

common questions

Variable substitution details in a configure or debug task

Replacing variables in configurations or debug tasks is a two-step process:

  • In the first step, all variables are evaluated for string results. If a variable appears more than once, it will only be evaluated once.
  • In the second pass, all the variables are replaced with the results of the first pass.

One consequence of this is that the evaluation of a variable (for example, a command-based variable implemented in an extension) hasno accessto other overridden variables in the setup or debug task. It only sees the original variables. This means that the variables cannot depend on each other (which guarantees isolation and makes substitution robust with respect to the order of evaluation).

Is variable substitution supported in user and workspace configurations?

Predefined variables are supported in a select number of configuration keys inconfiguration.jsonfiles as terminalcwd,environment,ConchamiShellArgsvalues. SomeDefinitionsCutwindow.titlehave their own variables:


View comments in the configuration editor (⌘,(Windows,LinuxCtrl+,)) for how to set specific variables.

Why is ${workspaceRoot} not documented?

The variable${workspace root}was rejected in favor of${workbook}to better align withmultiroot workspaceSupport support.

Why are variables in tasks.json not resolving?

Not all values ​​intasks.jsonsupport for variable substitution. specifically, onlydomain,arguments, mioptionssupport for variable substitution. input variables inAppetizerThe section will not resolve because nesting of input variables is not supported.

(Video) Angular Tutorial - 10 - Template Reference Variables

How can I know the real value of a variable?

An easy way to check the runtime value of a variable is to create VS Codehomeworkto send the value of the variable to the console. For example, to see the resolved value of${workbook}, you can compile and run (Terminal>run task) the following simple task 'echo' intasks.json:

{ "version":"2.0.0", "Chores": [{ "label":"eco", "writes":"Concha", "domain":"echo ${workbook}"}]}



How do I add references to Visual Studio code? ›

  1. Launch Visual Studio Code.
  2. Open your project folder.
  3. Launch VS Code Command Palette by pressing F1 or Ctrl+Shift+P or Menu Bar > View > Command Palette.

How do I view variables in Visual Studio code? ›

  1. Set a breakpoint in your code, and start debugging by pressing F5 or selecting Debug > Start Debugging.
  2. When paused at the breakpoint, hover over any variable in the current scope. A data tip appears, showing the name and current value of the variable.
Apr 29, 2022

How to check variable value in Visual Studio? ›

To View the Value of a Local Variable:
  1. Start a debugging session. In Visual Studio, open a CUDA-based project. Define at least one breakpoint. From Nsight menu, choose Start CUDA Debugging. ...
  2. From the Debug menu, choose Windows > Locals. The Locals window opens.

How do you access environment variables in VS Code? ›

You can also reference environment variables through the ${env:Name} syntax (for example, ${env:USERNAME} ).

How do I add a reference library in Visual Studio? ›

To add a reference to a type library in Visual Studio
  1. Install the COM DLL or EXE file on your computer, unless a Windows Setup.exe file performs the installation for you.
  2. Choose Project, Add Reference.
  3. In the Reference Manager, choose COM.
  4. Select the type library from the list, or browse for the . ...
  5. Choose OK.
Sep 15, 2021

How to add a reference in Visual Studio C#? ›

Add a reference
  1. In Solution Explorer, right-click the References or Dependencies node, and then choose either Add Project Reference, Add Shared Project Reference, or Add COM Reference from the context menu. ...
  2. Select a reference to add, and then select OK.
Sep 30, 2022

How do I view system variables? ›

On the Windows taskbar, right-click the Windows icon and select System. In the Settings window, under Related Settings, click Advanced system settings. On the Advanced tab, click Environment Variables.

How do you identify a variable in a code? ›

When you assign a variable, you use the = symbol. The name of the variable goes on the left and the value you want to store in the variable goes on the right. Here we've assigned the value 'Joe' , which is a string, to the variable first_name .

How do I find the address of a variable in Visual Studio? ›

One way to find the address of a variable in Visual Studio is to use the QuickWatch window (under the debug menu if you don't know the hot key, Ctrl + Alt + Q ). If you type &a , it will display the address of variable a .

Which commands display variable values? ›

To display the values of environment variables, use the printenv command. If you specify the Name parameter, the system only prints the value associated with the variable you requested.

How do you check if there is a value in a variable? ›

To check if a variable is not given a value, you would only need to check against undefined and null. This is assuming 0 , "" , and objects(even empty object and array) are valid "values".

How do I find global variables in Visual Studio? ›

You can go to the quick-watch window - Ctrl + Alt + Q , enter the variable name there, and press Add Watch . The variable will be added to the Watch window. Save this answer.

How do I access user environment variables? ›

You can follow these steps:
  1. Click Start , type Accounts in the Start search box, and then click User Accounts under Programs. ...
  2. In the User Accounts dialog box, click Change my environment variables under Tasks.
  3. Make the changes that you want to the user environment variables for your user account, and then click OK.
Dec 6, 2021

How can I see all environment variables? ›

To list all the environment variables, use the command " env " (or " printenv "). You could also use " set " to list all the variables, including all local variables.

How do I find environment variables? ›

On Windows

Select Start > All Programs > Accessories > Command Prompt. 2. In the command window that opens, enter echo %VARIABLE%.

How do I link a data source in Visual Studio? ›

Open your project in Visual Studio, and then choose Project > Add New Data Source to start the Data Source Configuration Wizard. Choose the type of data source to which you'll be connecting. Choose DataSet from the list of options. Choose the database or databases that will be the data source for your dataset.

Where are Visual Studio references stored? ›

SOLUTION. When you add your first test to a new test project in Visual Studio, references to the required assemblies are automatically referenced. By default, Visual Studio references assemblies stored in the GAC (Global Assembly Cache) with their specific version number.

How do you create a reference library? ›

  1. Open EndNote X. In the dialog box that appears, select Create a new library OR from the menu bar, select File > New.
  2. The New Reference Library dialog box will appear. Enter a name for your new library. ...
  3. Choose where you would like to save your new library.
  4. Click the Save button. The new EndNote library appears.
Nov 11, 2022

How do I add a reference to a DLL in Visual Studio C++? ›

In Solution Explorer, select the project. On the Project menu, click Add References. In Visual C++, click References on the Project menu, and then click Add New Reference. In the Add References dialog box, click the tab that corresponds with the category that you want to add a reference to.

Where are references stored in C#? ›

While value types are stored generally in the stack, reference types are stored in the managed heap. A value type derives from System. ValueType and contains the data inside its own memory allocation.

How do I get a list of System Variables in Windows? ›

Select Start > All Programs > Accessories > Command Prompt. In the command window that opens, enter set. A list of all the environment variables that are set is displayed in the command window.

How do I get system variable PATH? ›

Select Start, select Control Panel. double click System, and select the Advanced tab. Click Environment Variables. In the section System Variables, find the PATH environment variable and select it.

Where are System Variables stored? ›

Changes to the system environment are written to the registry and usually require the computer to be re-started to take effect. Machine environment variables are stored or retrieved from the following registry location: HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment .

How do you identify variable names? ›

A variable name must start with a letter or the underscore character. A variable name cannot start with a number. A variable name can only contain alpha-numeric characters and underscores (A-z, 0-9, and _ ) Variable names are case-sensitive (age, Age and AGE are three different variables)

How do I see variables in VS code python? ›

In VSCode, there are two ways to view script variables besides setting breakpoints:
  1. Open the " OUTLINE " column in the lower left corner of VSCode:
  2. Right-click " Run Current File in Python Interactive Window " in the script, and select " Show variables active in jupyter kernel ":
Oct 18, 2020

How can we display the address of a variable in C? ›

To output address of a variable, %p format specifier is used. How %p will display an address is implementation defined. It means that the output of %p could vary from compiler to compiler. An address is a non-negative integer.

What is variable command? ›

This command assigns one or more strings to a variable name for evaluation later in the input script or during a simulation. Variables can thus be useful in several contexts. A variable can be defined and then referenced elsewhere in an input script to become part of a new input command.

Which function is used to see a variable type? ›

The gettype() function returns the type of a variable.

Which of the listed commands are used to display environment variables? ›

To display your current environment variables, use the env command.

How can you quickly see the value of a variable? ›

Hover over a variable to see its value.

The most commonly used way to look at variables is the DataTip. When stopped in the debugger hover the mouse cursor over the variable you want to look at. The DataTip will appear showing you the value of that variable.

How do you find the value stored in a variable? ›

To retrieve a value from a variable

Use the variable name following the equal ( = ) sign in an assignment statement. The following example reads the value of the variable startValue and then uses the value of the variable counter in an expression.

What is the difference between a variable and a value? ›

Definition: A variable is a holder for a representation of a value. A variable does have location in time and space. Also, variables, unlike values, can be updated; that is, the current value of the variable can be replaced by another value.

How do you display the global variable values? ›

  1. Use the SHOW GLOBALS command to display the GLOBALS panel.
  2. Press the Show Field key to display the entire entry field. The maximum length for a global variable on the Show Global Variable screen is 32,768 bytes.
  3. Type the value for the variable on the lines provided.

How do you identify a global variable? ›

A global variable in Python is often declared as the top of the program. In other words, variables that are declared outside of a function are known as global variables. You can access global variables in Python both inside and outside the function. Def fn1():

How can you get an environment variable from a program? ›

In most Unix and Unix-like command-line shells, an environment variable's value is retrieved by placing a $ sign before the variable's name. If necessary, the name can also be surrounded by braces. In Unix and Unix-like systems, the names of environment variables are case-sensitive.

How do you access variables in an object? ›

An object value can be accessed by a Dot Notation and a Bracket Notation. To get the object value through a variable key, the value or expression inside the bracket notation must match with the existing key name, then it returns a value. The bracket notation, unlike the dot notation can be used with variables.

How to get all environment variables command line? ›

You can open a Command Prompt, type set , and press Enter to display all current environment variables on your PC. You can open PowerShell, type Get-ChildItem Env: , and press Enter to display all current environment variables on your PC.

How to list all local variables and environment variables and functions? ›

Local variables are only available in the current shell. Using the set built-in command without any options will display a list of all variables (including environment variables) and functions.

What is the default path in environment variables? ›

Path. Default Value: C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem; etc. Details: Contains a list of paths to binary files used by various programs.

How do I print all environment variables? ›

The env command is generally used by shell scripts to launch the correct interpreter but you can also use the env command to list available environment variables. The env command if applied without any arguments and options, will print all the available environment variables.

How to set environment variables command line? ›

There are two ways to set an environment variable on the fly:
  1. Set the variable on its own line, then use it anywhere: $ SOMETHING="some value" $ echo $SOMETHING some value.
  2. Set the variable before a command, on the same line: $ SOMETHING="a value" env ... SOMETHING=a value ...

How do I view Environment Variables in Visual Studio? ›

In Visual Studio, we can set ASPNETCORE_ENVIRONMENT in the debug tab of project properties. Open project properties by right clicking on the project in the solution explorer and select Properties. This will open properties page. Click on Debug tab and you will see Environment Variables as shown below.

How do I view global variables in Visual Studio? ›

You can go to the quick-watch window - Ctrl + Alt + Q , enter the variable name there, and press Add Watch . The variable will be added to the Watch window. Save this answer. Show activity on this post.

How do I display all environment variables? ›

To list all the environment variables, use the command " env " (or " printenv "). You could also use " set " to list all the variables, including all local variables.

How do I read all environment variables? ›

To display the values of environment variables, use the printenv command. If you specify the Name parameter, the system only prints the value associated with the variable you requested.

What command is used to view the environment variables? ›

To display your current environment variables, use the env command. An environment variable that is accessible to all your processes is called a global variable.

How do I view environment variables in frontend? ›

In summary, here are the steps to make your environment variables accessible in your front-end containers:
  1. Add a config. ...
  2. Add the bash script to your project.
  3. Use the completed Dockerfile to build your project.
  4. Start your container using -e to specify the environment variables.
Mar 4, 2021


1. Reference Vs Value In JavaScript
(Web Dev Simplified)
2. Selecting the correct Python interpreter in VSCode's Python Extension
(Galvanize Data Science)
3. How To Create Custom VSCode Snippets
(Web Dev Simplified)
4. Statements and Variables - Coding Nuts and Bolts (Learn to code quickly!!!)
(Coding with Paris)
5. Python in Visual Studio Code - VSCode Features You Need to Know
(Tech With Tim)
6. How to change variable names in VSCode easily #vscode #tips #shorts #javascript_tutorial #javascript
(Oguz is Coding)


Top Articles
Latest Posts
Article information

Author: Dean Jakubowski Ret

Last Updated: 16/09/2023

Views: 6375

Rating: 5 / 5 (70 voted)

Reviews: 93% of readers found this page helpful

Author information

Name: Dean Jakubowski Ret

Birthday: 1996-05-10

Address: Apt. 425 4346 Santiago Islands, Shariside, AK 38830-1874

Phone: +96313309894162

Job: Legacy Sales Designer

Hobby: Baseball, Wood carving, Candle making, Jigsaw puzzles, Lacemaking, Parkour, Drawing

Introduction: My name is Dean Jakubowski Ret, I am a enthusiastic, friendly, homely, handsome, zealous, brainy, elegant person who loves writing and wants to share my knowledge and understanding with you.