From 9da3b81d87ca4ae63e319e3f0e107aeb4f7ba0ac Mon Sep 17 00:00:00 2001 From: Trevor Crawford Date: Wed, 4 Dec 2024 17:42:39 -0500 Subject: [PATCH] Added terminal shell support documentation to user guide Co-authored-by: Aparna Michael --- docs/user-guide.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/user-guide.md b/docs/user-guide.md index bc9fa96b..851cd14e 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -7,7 +7,8 @@ For information regarding known issues and limitations, refer to our [Common Iss - [Software requirements](#software-requirements) - [Application requirements](#application-requirements) - [Configure your Java runtime for language servers](#configure-your-java-runtime-for-language-servers) - - [External Settings](#external-extension-settings) + - [External extension settings](#external-extension-settings) + - [Terminal shell support](#terminal-shell-support) - [Open the Liberty dashboard](#open-the-liberty-dashboard) - [Run your application on Liberty using dev mode](#run-your-application-on-liberty-using-dev-mode) - [Use the Liberty dashboard](#use-the-liberty-dashboard) @@ -76,6 +77,15 @@ For LemMinX, Liberty Tools for Visual Studio Code will check for the Java versio | `xml.java.home` | This setting allows a user to define their LemMinX language server runtime without altering the `JAVA_HOME` environment variable. | Not set | | `java.jdt.ls.java.home` | This setting specifies the folder path to the JDK (17 or later) that is used to launch the Java Language Server. This setting replaces the Java extension's embedded JRE to start the language servers. | Not set | +### Terminal shell support + +Liberty Tools supports the default shell types for each OS in the Visual Studio Code terminal. These include: +- Linux: Bash or sh +- macOS: Bash or Zsh +- Windows: Command Prompt (cmd.exe) + +It may be possible to use other shell types, but support is not guaranteed. Please feel free to open an enhancement issue if your preferred shell type is not supported: https://github.com/OpenLiberty/liberty-tools-vscode/issues. + ## Open the Liberty dashboard By default, the Liberty dashboard appears in the Project Explorer side bar. Optionally, you can drag the Liberty dashboard into the Activity Bar.