microsoft / microsoft/terminal

Custom variables in settings.json for easier profile configuration

Open
#9,185 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Settings Issue-Feature Product-Terminal
Dominant language
C++
Stars
105k
Forks
9.6k
Avg merge
3d 17h
Merged PRs (30d)
29

Description

# Description of the new feature/enhancement
Let one define custom variables in settings.json for use with profiles.
E.g. define myCustomVariable for later use within commandline to avoid adding same long path to SSH key file for every profile name.
Would also be great to reuse current profile parameters such as "name" to connect to this hostname by stating $profile.name with SSH as shown in example.

# Proposed technical implementation details (optional)
```
"profiles":
{
"defaults":
{
"myCustomVariable": "C:\\Users\\USERNAME\\SSH_KEY_FILE_PATH.key"
},
"list":
[
{
"name": "HOSTNAME",
"commandline": "ssh -i $myCustomVariable $profile.name",
},
```

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing Windows Terminal's settings.json profile configuration and the proposed defaults and list examples. Define the scope and expansion rules for custom variables and references such as $profile.name; the work is done when the example profile configuration is supported consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.