en-US.json

{
  "root": [
    {
      "name": "~",
      "tip": [
        "Start in the user's home directory"
      ],
      "options": [
        {
          "name": "-d",
          "alias": [
            "--distribution"
          ],
          "tip": [
            "U: -d|--distribution <Distro>\n",
            "Run the specified distribution"
          ]
        },
        {
          "name": "-u",
          "alias": [
            "--user"
          ],
          "next": 0,
          "tip": [
            "U: -u|--user <user>\n",
            "Run as the specified user"
          ]
        },
        {
          "name": "--system",
          "tip": [
            "Start a shell for the system distribution"
          ]
        },
        {
          "name": "-e",
          "alias": [
            "--exec"
          ],
          "next": 0,
          "tip": [
            "U: -e|--exec <command>\n",
            "Execute the specified command without using the default Linux shell"
          ]
        }
      ]
    }
  ],
  "options": [
    {
      "name": "--install",
      "tip": [
        "U: --install [Options] [<distribution>]\n",
        "Install Windows Subsystem for Linux (WSL) distributions for Linux\n",
        "To view the list of available distributions, use wsl --list --online"
      ],
      "next": [
        {
          "name": "--no-launch",
          "tip": [
            "Install the distribution without launching it afterward"
          ]
        },
        {
          "name": "--web-download",
          "tip": [
            "Download the distribution from the Internet instead of the Microsoft Store"
          ]
        }
      ]
    },
    {
      "name": "--update",
      "tip": [
        "Update Windows Subsystem for Linux (WSL) packages"
      ],
      "next": [
        {
          "name": "--web-download",
          "tip": [
            "Download updates from the Internet instead of the Microsoft Store"
          ]
        },
        {
          "name": "--pre-release",
          "tip": [
            "Download pre-release versions if available (implies --web-download)"
          ]
        }
      ]
    },
    {
      "name": "-l",
      "alias": [
        "--list"
      ],
      "tip": [
        "U: -l|--list [options]\n",
        "List distributions"
      ],
      "next": [
        {
          "name": "-o",
          "alias": [
            "--online"
          ],
          "tip": [
            "U: -o|--online\n",
            "Show a list of available distributions that can be installed"
          ]
        },
        {
          "name": "--all",
          "tip": [
            "List all distributions\n",
            "Including those currently being installed or uninstalled"
          ]
        },
        {
          "name": "--running",
          "tip": [
            "List only currently running distributions"
          ]
        },
        {
          "name": "-q",
          "alias": [
            "--quiet"
          ],
          "tip": [
            "U: -q|--quiet\n",
            "Show only distribution names"
          ]
        },
        {
          "name": "-v",
          "alias": [
            "--verbose"
          ],
          "tip": [
            "U: -v|--verbose\n",
            "Show detailed information for all distributions"
          ]
        }
      ]
    },
    {
      "name": "--mount",
      "tip": [
        "U: --mount [Options] <Disk>\n",
        "Attach and mount physical or virtual disks in all WSL 2 distributions"
      ],
      "next": [
        {
          "name": "--vhd",
          "tip": [
            "U: --vhd <Disk>\n",
            "Specify that <Disk> represents a virtual hard disk"
          ]
        },
        {
          "name": "--bare",
          "tip": [
            "Attach the disk to WSL2 without mounting it"
          ]
        },
        {
          "name": "--name",
          "tip": [
            "U: --name <Name>\n",
            "Use a custom name for the mount point"
          ]
        },
        {
          "name": "--type",
          "tip": [
            "U: --type <Type>\n",
            "File system to use when mounting the disk, defaults to ext4 if not specified"
          ]
        },
        {
          "name": "--partition",
          "tip": [
            "U: --partition <Index>\n",
            "Partition index to mount, defaults to the entire disk if not specified"
          ]
        }
      ]
    },
    {
      "name": "--export",
      "tip": [
        "U: --export <distribution> <file_name> [options]\n",
        "Export the distribution as a tar file; for standard output, the filename can be \"-\"\n",
        "E: wsl --export ubuntu \"$env:UserProfile\\Desktop\\export.tar\""
      ],
      "next": [
        {
          "name": "--vhd",
          "tip": [
            "U: --vhd <file_name>\n",
            "Specify exporting the distribution as a .vhdx file"
          ]
        }
      ]
    },
    {
      "name": "--import",
      "tip": [
        "U: --import <distribution> <Install_location> <file_name> [options]\n",
        "Import the specified tar as a new distribution; for standard input, the filename can be \"-\"\n",
        "E: wsl --import ubuntu \"$env:UserProfile\\Desktop\" \"$env:UserProfile\\Desktop\\export.tar\""
      ],
      "next": [
        {
          "name": "--version",
          "tip": [
            "U: --version <version>\n",
            "Specify the version to use for the new distribution"
          ]
        },
        {
          "name": "--vhd",
          "tip": [
            "U: --vhd <file_name>\n",
            "Specify the provided file as a .vhdx file instead of a tar file\n",
            "This operation will create a copy of the .vhdx file at the specified installation location"
          ]
        }
      ]
    },
    {
      "name": "-d",
      "alias": [
        "--distribution"
      ],
      "tip": [
        "U: -d|--distribution <Distro>\n",
        "Run the specified distribution"
      ]
    },
    {
      "name": "-u",
      "alias": [
        "--user"
      ],
      "next": 0,
      "tip": [
        "U: -u|--user <user>\n",
        "Run as the specified user"
      ]
    },
    {
      "name": "--cd",
      "next": 0,
      "tip": [
        "U: --cd <Directory>\n",
        "Set the specified directory as the current working directory\n",
        "If using ~, it will use the Linux user's home path\n",
        "If the path starts with a / character, it will be interpreted as an absolute Linux path\n",
        "Otherwise, the value must be an absolute Windows path"
      ]
    },
    {
      "name": "--system",
      "tip": [
        "Start a shell for the system distribution"
      ]
    },
    {
      "name": "-e",
      "alias": [
        "--exec"
      ],
      "next": 0,
      "tip": [
        "U: -e|--exec <command>\n",
        "Execute the specified command without using the default Linux shell"
      ]
    },
    {
      "name": "--shell-type",
      "tip": [
        "U: --shell-type <shell-type>\n",
        "Execute the specified command using the provided shell type\n",
        "E: -shell-type standard   --- Execute the specified command using the default Linux shell"
      ],
      "next": [
        {
          "name": "standard",
          "tip": [
            "Execute the specified command using the default Linux shell"
          ]
        },
        {
          "name": "login",
          "tip": [
            "Execute the specified command using the default Linux shell as a login shell"
          ]
        },
        {
          "name": "none",
          "tip": [
            "Execute the specified command without using the default Linux shell"
          ]
        }
      ]
    },
    {
      "name": "--debug-shell",
      "tip": [
        "Open a WSL2 debug shell for diagnostics"
      ]
    },
    {
      "name": "--event-viewer",
      "tip": [
        "Open the Application view of Windows Event Viewer"
      ]
    },
    {
      "name": "--release-notes",
      "tip": [
        "Open a web browser to view the WSL release notes page"
      ]
    },
    {
      "name": "--shutdown",
      "tip": [
        "Immediately terminate all running distributions and WSL 2 lightweight virtual machines"
      ]
    },
    {
      "name": "--status",
      "tip": [
        "Display the status of Windows Subsystem for Linux\n",
        "Examples: default distribution type, default distribution, and kernel version, etc."
      ]
    },
    {
      "name": "--unmount",
      "next": 0,
      "tip": [
        "U: --unmount [Disk]\n",
        "Unmount and detach a disk from all WSL2 distributions\n",
        "If called without parameters, unmount and detach all disks"
      ]
    },
    {
      "name": "-v",
      "alias": [
        "--version"
      ],
      "tip": [
        "U: -v|--version\n",
        "Check version information about WSL and its components"
      ]
    },
    {
      "name": "--import-in-place",
      "next": 0,
      "tip": [
        "U: --import-in-place <Distro> <FileName>\n",
        "Import the specified .vhdx as a new distribution.\n",
        "This virtual hard disk must be formatted with the ext4 file system type"
      ]
    },
    {
      "name": "-s",
      "alias": [
        "--set-default"
      ],
      "tip": [
        "U: -s|--set-default <Distribution>\n",
        "Set a distribution as the default"
      ]
    },
    {
      "name": "--set-version",
      "next": 0,
      "tip": [
        "U: --set-version <Distribution> <Version>\n",
        "Change the version of the specified distribution"
      ]
    },
    {
      "name": "--set-default-version",
      "next": 0,
      "tip": [
        "U: --set-default-version <Version>\n",
        "Change the default installation version for new distributions"
      ]
    },
    {
      "name": "-t",
      "alias": [
        "--terminate"
      ],
      "tip": [
        "U: -t|--terminate <Distribution>\n",
        "Terminate the specified distribution"
      ]
    },
    {
      "name": "--unregister",
      "tip": [
        "U: --unregister <Distribution>\n",
        "Unregister the distribution and delete the root file system"
      ]
    }
  ],
  "common_options": [
    {
      "name": "--help",
      "tip": [
        "View a list of available options and commands in WSL."
      ]
    }
  ],
  "info": {
    "completion_info": {
      "url": "https://github.com/microsoft/WSL",
      "description": [
        "WSL - Windows Subsystem for Linux."
      ]
    },
    "tip": {
      "--distribution": "Run distribution -- {{ $Distro }}",
      "--set-default": "Set default distribution --- {{ $Distro }}",
      "--terminate": "Terminate distribution -- {{ $Distro }}",
      "--unregister": "Unregister distribution -- {{$Distro}}",
      "--export": "Export distribution -- {{ $Distro }}"
    }
  }
}