docs/che-7/end-user-guide/defining-custom-commands-for-che-theia/index.html - gerrit/www.eclipse.org/che - Git at Google

 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <title>Defining custom commands for Che-Theia :: Eclipse Che Documentation</title>
     <link rel="canonical" href="https://www.eclipse.org/che/docs/che-7/end-user-guide/defining-custom-commands-for-che-theia/">
     <meta name="keywords" content="end-user-guide, defining-custom-commands-for-che-theia">
     <meta name="generator" content="Antora 2.3.4">
     <link rel="stylesheet" href="../../../_/css/site.css">
 <link rel="stylesheet" href="../../../_/css/extra.css">
 <link rel="stylesheet" href="../../../_/font-awesome-4.7.0/css/font-awesome.min.css">
 <link rel="icon" href="../../../favicon.ico" type="image/x-icon">
     <script async src="https://www.googletagmanager.com/gtag/js?id=UA-37306001-2"></script>
     <script>function gtag(){dataLayer.push(arguments)};window.dataLayer=window.dataLayer||[];gtag('js',new Date());gtag('config','UA-37306001-2')</script>
     <script>var uiRootPath = '../../../_'</script>
   </head>
   <body class="article">
 <header class="header" role="banner">
   <nav class="navbar">
     <div class="navbar-brand">
       <div class="navbar-item">
         <button class="navbar-burger" data-target="topbar-nav">
           <span></span>
           <span></span>
           <span></span>
         </button>
         <img src="../../../_/img/icon-eclipse-che.svg" class="navbar-logo" alt="Eclipse Che logo">
         <a href="https://www.eclipse.org/che/docs">Eclipse Che Documentation</a>
       </div>
     </div>
     <div id="topbar-nav" class="navbar-menu">
       <div class="navbar-end">
         <div class="navbar-item hide-for-print">
           <script async src="https://cse.google.com/cse.js?cx=002898025167115630151:gnr5edrg2eo"></script>
           <div class="gcse-searchbox" enableAutoComplete="true"></div>
         </div>
         <a class="navbar-item" href="https://www.eclipse.org/che/docs">Home</a>
         <a class="navbar-item" href="https://che.eclipse.org/">Blog</a>
         <a class="navbar-item" href="https://github.com/eclipse/che">Source Code</a>
       </div>
     </div>
   </nav>
   <div class="gcse-searchresults"></div>
 </header><div class="body">
 <div class="nav-container" data-component="che-7" data-version="master">
   <aside class="nav">
     <div class="panels">
 <div class="nav-panel-menu is-active" data-panel="menu">
   <nav class="nav-menu">
     <h3 class="title"><a href="../../overview/introduction-to-eclipse-che/">Documentation</a></h3>
 <ul class="nav-list">
   <li class="nav-item" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../overview/introduction-to-eclipse-che/">Introduction to Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../overview/che-architecture/">Che architecture</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../hosted-che/hosted-che/">Eclipse Che hosted by Red Hat</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">End-user Guide</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../navigating-che/">Navigating Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../navigating-che-using-the-dashboard/">Navigating Che: dashboard</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../importing-certificates-to-browsers/">Importing certificates to browsers</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../accessing-che-from-openshift-developer-perspective/">Navigating Che from OpenShift Developer Perspective</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../che-theia-ide-basics/">Che-Theia IDE basics</a>
 <ul class="nav-list">
   <li class="nav-item is-current-page" data-depth="2">
     <a class="nav-link" href="./">Defining custom commands for Che-Theia</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../version-control/">Version Control</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../che-theia-troubleshooting/">Che-Theia Troubleshooting</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode/">Differences in how Che-Theia Webview works on a single-host mode comparing to a multi-host mode</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../workspaces-overview/">Using developer workspaces</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../creating-a-workspace-from-code-sample/">Creating a workspace from code sample</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../creating-a-workspace-from-remote-devfile/">Creating a workspace from a remote devfile using the dashboard</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../creating-a-workspace-from-local-devfile-using-chectl/">Creating a workspace from local devfile using chectl</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../creating-a-workspace-by-importing-the-source-code-of-a-project/">Creating a workspace by importing the source code of a project</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../configuring-a-workspace-with-dashboard/">Configuring a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../running-a-workspace-with-dashboard/">Running a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../importing-kubernetes-applications-into-a-workspace/">Importing Kubernetes applications into a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../remotely-accessing-workspaces/">Remotely accessing workspaces</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../mounting-a-secret-as-a-file-or-an-environment-variable-into-a-workspace-container/">Mounting a secret as a file or an environment variable into a workspace container</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../authenticating-on-scm-server-with-a-personal-access-token/">Authenticating on SCM Server with a personal access token</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../authoring-devfiles/">Authoring devfiles</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../authoring-devfiles-version-1/">Authoring devfiles version 1</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../authoring-devfiles-version-2/">Authoring devfiles version 2</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../customizing-developer-environments/">Customizing developer environments</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../what-is-a-che-theia-plug-in/">What is a Che-Theia plug-in</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../adding-a-vs-code-extension-to-a-workspace/">Adding a VS Code extension to a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../adding-a-vs-code-extension-to-the-che-plugin-registry/">Adding a VS Code extension to the Che plug-ins registry</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../publishing-metadata-for-a-vs-code-extension/">Publishing a VS Code extension</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../testing-a-visual-studio-code-extension-in-che/">Testing a VS Code extension in Che</a>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../using-alternative-ides-in-che/">Using alternative IDEs in Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../support-for-jetbrains-ides/">JetBrains IDEs</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../using-jetbrains-intellij-idea-community-edition/">Using IntelliJ Idea Community Edition</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../using-jetbrains-intellij-idea-ultimate-edition/">Using IntelliJ Idea Ultimate Edition</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../configuring-an-existing-workspace-to-use-intellij-idea/">Configuring an existing workspace to use IntelliJ IDEA</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../using-jetbrains-webstorm/">Using WebStorm</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../provisioning-jetbrains-activation-code-for-offline-use/">Provisioning activation code for offline use</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../support-for-theia-based-ides/">Theia-based IDEs</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../adding-tools-to-che-after-creating-a-workspace/">Adding tools to Che after creating a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../using-private-container-registries/">Using private container registries</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../using-artifact-repositories-in-a-restricted-environment/">Using artifact repositories in a restricted environment</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../using-maven-artifact-repositories/">Using Maven artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../using-gradle-artifact-repositories/">Using Gradle artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../using-python-artifact-repositories/">Using Python artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../using-go-artifact-repositories/">Using Go artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../using-nuget-artifact-repositories/">Using NuGet artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../using-npm-artifact-repositories/">Using npm artifact repositories</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../troubleshooting-che/">Troubleshooting Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../viewing-che-workspaces-logs/">Viewing Che workspaces logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../investigating-failures-at-a-workspace-start-using-the-verbose-mode/">Troubleshooting workspace start failures</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../troubleshooting-slow-workspaces/">Troubleshooting slow workspaces</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../troubleshooting-network-problems/">Troubleshooting network problems</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Installation Guide</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../installation-guide/supported-platforms/">Supported platforms</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../installation-guide/configuring-the-che-installation/">Configuring the Che installation</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/installing-che/">Installing Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/installing-che-in-cloud/">Installing Che in cloud</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-openshift-4-using-operatorhub/">Installing Che on OpenShift 4 using OperatorHub</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-openshift-4-using-cli/">Installing Che on OpenShift 4 using CLI</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-openshift-3-using-the-operator/">Installing Che on OpenShift 3</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-kubespray/">Installing Che on Kubespray</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-aws/">Installing Che on AWS</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-google-cloud-platform/">Installing Che on Google Cloud</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-microsoft-azure/">Installing Che on Microsoft Azure</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/installing-che-locally/">Installing Che locally</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-codeready-containers/">Installing Che on CodeReady Containers</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-docker-desktop/">Installing Che on Docker Desktop</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-minikube/">Installing Che on Minikube</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-minishift/">Installing Che on Minishift</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-kind/">Installing Che on Kind</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/using-the-chectl-management-tool/">Using the chectl management tool</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/installing-che-in-a-restricted-environment/">Installing Che in restricted environment</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/advanced-configuration/">Advanced configuration</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/advanced-configuration-options-for-the-che-server-component/">Advanced configuration options for Che server</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-namespace-strategies/">Configuring workspace target namespace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-storage-strategies/">Configuring storage strategies</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-storage-types/">Configuring storage types</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-the-number-of-workspaces-that-a-user-can-run/">Configuring the number of workspaces that a user can run</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-the-number-of-workspaces-that-a-user-can-create/">Configuring the number of workspaces that a user can create</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-workspace-exposure-strategies/">Configuring workspace exposure strategies</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-workspaces-nodeselector/">Configuring workspaces nodeSelector</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-che-hostname/">Configuring Che hostname</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-ingresses/">Configuring Kubernetes Ingress</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-routes/">Configuring OpenShift Route</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/">Deploying Che with support for Git repositories with self-signed certificates</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/installing-che-using-storage-classes/">Installing Che using storage classes</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/importing-untrusted-tls-certificates/">Importing untrusted TLS certificates to Che</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/switching-between-external-and-internal-communication/">Switching between external and internal ways in inter-component communication</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page/">Setting up the Keycloak che-username-readonly theme for the Eclipse Che login page</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container/">Mounting a Secret or a ConfigMap as a file or an environment variable into a Eclipse&#160;Che container</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/enabling-dev-workspace-engine/">Enabling Dev Workspace engine</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/upgrading-che/">Upgrading Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/upgrading-che-using-operatorhub/">Upgrading Che using OperatorHub</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/upgrading-che-using-the-cli-management-tool/">Upgrading Che using the CLI management tool</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/upgrading-che-using-the-cli-management-tool-in-restricted-environment/">Upgrading Che in restricted environment</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/upgrading-che-namespace-strategies-other-than-per-user/">Updating Che namespace strategies other than 'per user'</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/uninstalling-che/">Uninstalling Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/uninstalling-che-after-operatorhub-installation-using-openshift-web-console/">Using the OpenShift web console</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/uninstalling-che-after-operatorhub-installation-using-openshift-cli/">Using OpenShift CLI</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/uninstalling-che-after-chectl-installation/">Using chectl</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Administration Guide</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/che-architecture-overview/">Che architecture</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/che-workspace-controller/">Che workspace controller</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/che-workspaces-architecture/">Che workspaces architecture</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../administration-guide/calculating-che-resource-requirements/">Calculating Che resource requirements</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/customizing-the-registries/">Customizing the registries</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/building-custom-registry-images/">Building custom registry images</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/running-custom-registries/">Running custom registries</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/retrieving-che-logs/">Retrieving Che logs</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/configuring-server-logging/">Configuring server logging</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/viewing-kubernetes-events/">Accessing Kubernetes events on OpenShift</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/viewing-operator-events/">Viewing the Operator events on OpenShift</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/viewing-che-server-logs/">Viewing Che server logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/viewing-external-service-logs/">Viewing external service logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/viewing-plug-in-broker-logs/">Viewing Plug-in broker logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/collecting-logs-using-chectl/">Collecting logs using chectl</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../administration-guide/monitoring-che/">Monitoring Che</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../administration-guide/tracing-che/">Tracing Che</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/backup-and-disaster-recovery/">Backup and disaster recovery</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/external-database-setup/">External database setup</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/persistent-volumes-backups/">Persistent Volumes backups</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/caching-images-for-faster-workspace-start/">Caching images for faster workspace start</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/defining-the-list-of-images-to-pull/">Defining the list of images</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/defining-the-memory-parameters-for-the-image-puller/">Defining the memory settings</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/installing-image-puller-using-che-operator/">Installing using the Che Operator</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/installing-image-puller-on-kubernetes-using-the-image-puller-operator/">Installing using the Kubernetes Image Puller Operator</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/installing-image-puller-on-openshift-using-operatorhub/">Installing on OpenShift 4</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/installing-image-puller-on-openshift-using-openshift-templates/">Installing on OpenShift 3</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/installing-image-puller-on-kubernetes-using-helm/">Installing using Helm</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/managing-identities-and-authorizations/">Managing identities and authorizations</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/authenticating-users/">Authenticating users</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/authorizing-users/">Authorizing users</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/configuring-authorization/">Configuring authorization</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/configuring-openshift-oauth/">Configuring OpenShift OAuth</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/removing-user-data/">Removing user data</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Contributor Guide</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../contributor-guide/branding-che-theia/">Branding Che-Theia</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../contributor-guide/developing-che-theia-plug-ins/">Developing Che-Theia plug-ins</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../contributor-guide/testing-che-theia-plug-ins/">Testing Che-Theia plug-ins</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../contributor-guide/publishing-che-theia-plug-ins/">Publishing Che-Theia plug-ins</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../contributor-guide/adding-support-for-a-new-language/">Adding support for a new language</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../contributor-guide/adding-support-for-a-new-debugger/">Adding support for a new debugger</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../contributor-guide/che-extensibility-reference/">Che extensibility reference</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../contributor-guide/che-extension-points/">Che extension points</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../contributor-guide/che-theia-plug-in-api/">Che-Theia plug-in API</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../contributor-guide/debug-adapter-protocol/">Debug Adapter Protocol</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../contributor-guide/language-server-protocol/">Language Server Protocol</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Extensions</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../extensions/eclipse-che4z/">eclipse-che4z.adoc</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../extensions/openshift-connector-overview/">OpenShift Connector</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/features-of-openshift-connector/">Features of OpenShift Connector</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/installing-openshift-connector-in-che/">Installing OpenShift Connector in Eclipse Che</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/authenticating-with-openshift-connector-from-che/">Authenticating with OpenShift Connector from Eclipse Che</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/creating-components-with-openshift-connector-in-che/">Creating Components with OpenShift Connector in Eclipse Che</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/connecting-source-code-from-github-to-a-openshift-component-using-openshift-connector/">Connecting source code from GitHub to a OpenShift Component</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../extensions/telemetry/">Telemetry</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/creating-a-telemetry-plugin/">Creating A Telemetry Plugin</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/the-woopra-telemetry-plugin/">The Woopra Telemetry Plugin</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../extensions/java-lombok/">Java Lombok</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../glossary/che-glossary/">Che glossary</a>
   </li>
 </ul>
   </li>
 </ul>
   </nav>
 </div>
 <div class="nav-panel-explore" data-panel="explore">
   <div class="context">
     <span class="title">Documentation</span>
     <span class="version">master</span>
   </div>
   <ul class="components">
     <li class="component is-current">
       <a class="title" href="../../overview/introduction-to-eclipse-che/">Documentation</a>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../../overview/introduction-to-eclipse-che/">master</a>
         </li>
       </ul>
     </li>
   </ul>
 </div>
     </div>
   </aside>
 </div>
 <main class="article">
 <div class="toolbar" role="navigation">
 <button class="nav-toggle"></button>
   <a href="../../overview/introduction-to-eclipse-che/" class="home-link"></a>
 <nav class="breadcrumbs" aria-label="breadcrumbs">
   <ul>
     <li><a href="../../overview/introduction-to-eclipse-che/">Documentation</a></li>
     <li>End-user Guide</li>
     <li><a href="../che-theia-ide-basics/">Che-Theia IDE basics</a></li>
     <li><a href="./">Defining custom commands for Che-Theia</a></li>
   </ul>
 </nav>
   <div class="edit-this-page"><a href="https://github.com/eclipse/che-docs/edit/master/modules/end-user-guide/pages/defining-custom-commands-for-che-theia.adoc">Edit this Page</a></div>
   </div>
   <div class="content">
 <aside class="toc sidebar" data-title="Contents" data-levels="2">
   <div class="toc-menu"></div>
 </aside>
 <article class="doc">
 <h1 class="page">Defining custom commands for Che-Theia</h1>
 <div id="preamble">
 <div class="sectionbody">
 <div class="paragraph">
 <p>The Che-Theia IDE allows users to define custom commands in a devfile that are then available when working in a workspace.</p>
 </div>
 <div class="paragraph">
 <p>This is useful, for example, for:</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p>Simplifying building, running, and debugging projects.</p>
 </li>
 <li>
 <p>Allowing lead developers to customize workspaces based on team requirements.</p>
 </li>
 <li>
 <p>Reducing time needed to onboard new team members.</p>
 </li>
 </ul>
 </div>
 <div class="paragraph">
 <p>See also <a href="../authoring-devfiles-version-2/" class="page">Authoring devfiles version 2</a>.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="che-theia-task-types_che"><a class="anchor" href="#che-theia-task-types_che"></a>Che-Theia task types</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>The following is an example of the <code>commands</code> section of a devfile.</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">commands:

   - name: Package Native App
     actions:
       - type: exec
         component: centos-quarkus-maven
         command: "mvn package -Dnative -Dmaven.test.skip"
         workdir: ${CHE_PROJECTS_ROOT}/quarkus-quickstarts/getting-started

   - name: Start Native App
     actions:
       - type: exec
         component: ubi-minimal
         command: ./getting-started-1.0-SNAPSHOT-runner
         workdir: ${CHE_PROJECTS_ROOT}/quarkus-quickstarts/getting-started/target

   - name: Attach remote debugger
     actions:
     - type: vscode-launch
       referenceContent: |
         {
           "version": "0.2.0",
           "configurations": [
             {
               "type": "java",
               "request": "attach",
               "name": "Attach to Remote Quarkus App",
               "hostName": "localhost",
               "port": 5005
             }
           ]
         }</code></pre>
 </div>
 </div>
 <div class="dlist">
 <dl>
 <dt class="hdlist1">Che commands</dt>
 <dd>
 <p><code>Package Native App</code> and <code>Start Native App</code></p>
 <div class="paragraph">
 <p>The Che commands are to be used to define tasks that will be executed in the workspace container.</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p>The <code>exec</code> type implies that the Che runner is used for command execution. The user can specify the component in whose container the command is executed.</p>
 </li>
 <li>
 <p>The <code>command</code> field contains the command line for execution.</p>
 </li>
 <li>
 <p>The <code>workdir</code> is the working directory in which the command is executed.</p>
 </li>
 <li>
 <p>The <code>component</code> field refers to the container where the command will be executed. The field contains the component <code>alias</code> where the container is defined.</p>
 </li>
 </ul>
 </div>
 </dd>
 <dt class="hdlist1">VS Code <code>launch</code> configurations</dt>
 <dd>
 <p><code>Attach remote debugger</code></p>
 <div class="paragraph">
 <p>VS Code <code>launch</code> configurations are commonly used to define debugging configuration. To trigger these configurations, press <b class="button">F5</b> or choose <strong>Start Debugging</strong> from the <strong>Debug</strong> menu. The configurations provide information to the debugger, such as the port to connect to for debugging or the type of the application to debug (Node.js, Java, and others.).</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p>The type is <code>vscode-launch</code>.</p>
 </li>
 <li>
 <p>It contains the <code>launch</code> configurations in the VS Code format.</p>
 </li>
 <li>
 <p>For more information about VS Code <code>launch</code> configurations, see the Debugging section on the <a href="https://code.visualstudio.com/docs/editor/debugging#_launch-configurations">Visual Studio documentation page</a>.</p>
 </li>
 </ul>
 </div>
 </dd>
 </dl>
 </div>
 <div class="paragraph">
 <p>Tasks of type <code>che</code>, also known as <code>exec</code> commands, can be executed from the <strong>Terminal&#8594;Run Task</strong> menu or by selecting them in the <strong>My Workspace</strong> panel. Other tasks are only available from <strong>Terminal&#8594;Run Task</strong>. Configurations to start with are available in the Che-Theia debugger.</p>
 </div>
 <div class="ulist">
 <div class="title">Additional resources</div>
 <ul>
 <li>
 <p><a href="https://raw.githubusercontent.com/eclipse/che-devfile-registry/master/devfiles/quarkus-command-mode/devfile.yaml">Quarkus command mode devfile, including a <code>theia</code> task and a <code>vscode-launch</code> task</a></p>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="running-and-debugging_che"><a class="anchor" href="#running-and-debugging_che"></a>Running and debugging</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Che-Theia supports the <a href="https://microsoft.github.io/debug-adapter-protocol/">Debug Adapter Protocol</a>. This protocol defines a generic way for how a development tool can communicate with a debugger. It means Che-Theia works with all <a href="https://microsoft.github.io/debug-adapter-protocol/implementors/adapters/">implementations</a>.</p>
 </div>
 <div class="ulist">
 <div class="title">Prerequisites</div>
 <ul>
 <li>
 <p>A running instance of Che. To install an instance of Che, see <a href="../../installation-guide/installing-che/" class="page">Installing Che</a>.</p>
 </li>
 </ul>
 </div>
 <div class="paragraph">
 <p><!-- vale Vale.Spelling = NO --></p>
 </div>
 <div class="paragraph">
 <p><!-- vale Vale.Terms = NO --></p>
 </div>
 <div class="paragraph">
 <div class="title">Procedure</div>
 <p>To debug an application:</p>
 </div>
 <div class="olist arabic">
 <ol class="arabic">
 <li>
 <p>Click <strong>Debug</strong> &#8594; <strong>Add Configuration</strong> for debugging or adding of a <code>launch</code> configuration to the project.</p>
 <div class="imageblock">
 <div class="content">
 <img src="../_images/ide/che-theia-basics-1.png" alt="che theia basics 1">
 </div>
 </div>
 </li>
 <li>
 <p>From the pop-up menu, select the appropriate configuration for the application that you are about to debug.</p>
 <div class="imageblock">
 <div class="content">
 <img src="../_images/ide/che-theia-basics-2.png" alt="che theia basics 2">
 </div>
 </div>
 </li>
 <li>
 <p>Update the configuration by modifying or adding attributes.</p>
 <div class="imageblock">
 <div class="content">
 <img src="../_images/ide/che-theia-basics-3.png" alt="che theia basics 3">
 </div>
 </div>
 </li>
 <li>
 <p>Breakpoints can be toggled by selecting the editor margin.</p>
 <div class="imageblock">
 <div class="content">
 <img src="../_images/ide/che-theia-basics-3-b.png" alt="che theia basics 3 b">
 </div>
 </div>
 </li>
 <li>
 <p>After opening the breakpoint menu, use the <strong>Edit Breakpoint</strong> command to add conditions.</p>
 <div class="imageblock">
 <div class="content">
 <img src="../_images/ide/che-theia-basics-3-c.png" alt="che theia basics 3 c">
 </div>
 </div>
 <div class="paragraph">
 <p>The IDE then displays the <code>Expresion</code> input field.</p>
 </div>
 <div class="imageblock">
 <div class="content">
 <img src="../_images/ide/che-theia-basics-3-d.png" alt="che theia basics 3 d">
 </div>
 </div>
 </li>
 <li>
 <p>To start debugging, click <strong>View&#8594;Debug</strong>.</p>
 <div class="imageblock">
 <div class="content">
 <img src="../_images/ide/che-theia-basics-4.png" alt="che theia basics 4">
 </div>
 </div>
 </li>
 <li>
 <p>In the <strong>Debug</strong> view, select the configuration and press <strong>F5</strong> to debug the application. Or, start the application without debugging by pressing <b class="button">Ctrl+F5</b>.</p>
 <div class="imageblock">
 <div class="content">
 <img src="../_images/ide/che-theia-basics-5.png" alt="che theia basics 5">
 </div>
 </div>
 </li>
 </ol>
 </div>
 <div class="paragraph">
 <p><!-- vale Vale.Spelling = YES --></p>
 </div>
 <div class="paragraph">
 <p><!-- vale Vale.Terms = YES --></p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="editing-task-and-launch-configuration_che"><a class="anchor" href="#editing-task-and-launch-configuration_che"></a>Editing a task and <code>launch</code> configuration</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <div class="title">Procedure</div>
 <p>To customize the configuration file:</p>
 </div>
 <div class="olist arabic">
 <ol class="arabic">
 <li>
 <p>Edit the <code>tasks.json</code> or <code>launch.json</code> configuration files.</p>
 </li>
 <li>
 <p>Add new definitions to the configuration file or modify the existing ones.</p>
 <div class="admonitionblock note">
 <table>
 <tr>
 <td class="icon">
 <i class="fa icon-note" title="Note"></i>
 </td>
 <td class="content">
 The changes are stored in the configuration file.
 </td>
 </tr>
 </table>
 </div>
 </li>
 <li>
 <p>To customize the task configuration provided by plug-ins, select the <strong>Terminal</strong> &#8594; <strong>Configure Tasks</strong> menu option, and choose the task to configure. The configuration is then copied to the <code>tasks.json</code> file and is available for editing.</p>
 </li>
 </ol>
 </div>
 </div>
 </div>
 </article>
   </div>
 </main>
 </div>
 <footer class="footer">
     <div><a href="https://www.eclipse.org" target="_blank">Eclipse Foundation</a> |
        <a href="https://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a> |
        <a href="https://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a> |
        <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">Eclipse Public License</a> |
        <a href="https://www.eclipse.org/legal" target="_blank">Legal Resources</a></div>
 </footer>

 <script src="../../../_/js/site.js"></script>
 <script async src="../../../_/js/vendor/highlight.js"></script>
   </body>
 </html>