| <!DOCTYPE html> |
| <html lang="en"> |
| <!-- Global site tag (gtag.js) - Google Analytics --> |
| <script async src="https://www.googletagmanager.com/gtag/js?id=UA-112407000-2"></script> |
| <script> |
| window.dataLayer = window.dataLayer || []; |
| |
| function gtag() { |
| dataLayer.push(arguments); |
| } |
| gtag('js', new Date()); |
| |
| gtag('config', 'UA-112407000-2'); |
| </script> |
| |
| <!-- Google Tag Manager --> |
| <script> |
| (function (w, d, s, l, i) { |
| w[l] = w[l] || []; |
| w[l].push({ |
| 'gtm.start': new Date().getTime(), |
| event: 'gtm.js' |
| }); |
| var f = d.getElementsByTagName(s)[0], |
| j = d.createElement(s), |
| dl = l != 'dataLayer' ? '&l=' + l : ''; |
| j.async = true; |
| j.src = |
| 'https://www.googletagmanager.com/gtm.js?id=' + i + dl; |
| f.parentNode.insertBefore(j, f); |
| })(window, document, 'script', 'dataLayer', 'GTM-KS8HHSF'); |
| </script> |
| <!-- End Google Tag Manager --> |
| |
| <head> |
| <base href="/codewind/" /> |
| <title>Project commands: Tools for VS Code | Codewind</title> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="Project commands: Tools for VS Code"> |
| <meta name="keywords" content="tools, vscode, visual, studio, code, commands, project, Codewind Developer Tools for VS Code project commands overview, connection commands, restart, debug"/> |
| <link rel="icon" type="image/png" sizes="16x16" href="images/favicon-16x16.png"> |
| <link rel="icon" type="image/png" sizes="32x32" href="images/favicon-32x32.png"> |
| <link href="https://fonts.googleapis.com/css?family=IBM+Plex+Sans:300,400,600&display=swap" rel="stylesheet"> |
| <!-- Bootstrap CSS CDN --> |
| <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" |
| integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous"> |
| <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" /> |
| <link rel="stylesheet" href="css/styles.css"> |
| <link rel="stylesheet" href="css/docs.css"> |
| |
| |
| </head> |
| |
| <body data-spy="scroll" data-target="#toc"> |
| <!-- Google Tag Manager (noscript) --> |
| <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KS8HHSF" |
| height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> |
| <!-- End Google Tag Manager (noscript) --> |
| <div class="main"> |
| <!-- Bootstrap NavBar --> |
| <nav class="navbar navbar-expand-lg navbar-light cw-banner fixed-top"> |
| <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" |
| data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" |
| aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| <a class="navbar-brand" href=""> |
| <img src="images/header-logo.svg" class="cw-header-logo" alt=""> |
| </a> |
| <div class="collapse navbar-collapse justify-content-end cw-navbar-padding" id="navbarNavDropdown"> |
| <ul class="navbar-nav cw-navbar-nav"> |
| <li class="nav-item cw-navbar-item cw-header-link"> |
| <a class="nav-link cw-nav-link" href="docindex.html">Docs</a> |
| </li> |
| <!-- li class="nav-item cw-navbar-item" id="download-li"> |
| <button onClick="window.location.href='https://microclimate.dev/download/codewind';" type="button" class="btn cw-download-button">Download</button> |
| <a href="https://microclimate.dev/download/codewind" class="nav-link cw-nav-link cw-download-link" href="#">Download</a> |
| </li> --> |
| |
| |
| <li class="nav-item cw-navbar-item" id="github-stars-button"> |
| <!-- Place this tag where you want the button to render. --> |
| <a class="github-button" href="https://github.com/eclipse/codewind" data-size="large" |
| data-show-count="true" aria-label="Star eclipse/codewind on GitHub">Star</a> |
| </li> |
| <!-- Smaller devices menu END --> |
| |
| </ul> |
| </div> |
| </nav> |
| <!-- NavBar END --> |
| |
| <!-- Bootstrap row --> |
| <div class="row" id="body-row"> |
| <!-- Sidebar --> |
| <div id="sidebar-container" class="bg-light"> |
| <!-- Bootstrap List Group --> |
| <ul class="list-group sticky-top bg-light cw-sticky-offset"> |
| <!-- Separator with title --> |
| <li class="list-group-item cw-sidebar-separator-title cw-text-gray d-flex bg-light align-items-center menu-collapsed"> |
| <small class="badge badge-success cw-margin-auto">DOCUMENTS</small> |
| </li> |
| <!-- /END Separator --> |
| <!-- Hard coded TOC --> |
| |
| <a href="#install_on_cloud" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Installing and Using Codewind on Cloud</span> |
| <span class="submenu-icon ml-auto"></span> |
| </div> |
| </a> |
| <div id="install_on_cloud" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| <a href="installoncloud" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Installing and Using Codewind on Kubernetes</span> |
| </div> |
| </a> |
| <a href="supportingmultipleusers" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Support for multiple users</span> |
| </div> |
| </a> |
| <a href="viewkibanalogs" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Viewing logs using Kibana in IBM Cloud Private</span> |
| </div> |
| </a> |
| </div> |
| |
| <a href="installlocally" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Installing Codewind locally</span> |
| </div> |
| </a> |
| |
| <a href="#codewind_for_eclipse" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Codewind for Eclipse</span> |
| <span class="submenu-icon ml-auto"></span> |
| </div> |
| </a> |
| <div id="codewind_for_eclipse" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| <a href="mdteclipseoverview" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Overview</span> |
| </div> |
| </a> |
| <a href="mdteclipsegettingstarted" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Installation and Getting Started</span> |
| </div> |
| </a> |
| <a href="mdteclipsemanagingprojects" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Managing Codewind projects</span> |
| </div> |
| </a> |
| <a href="mdteclipsebuildproject" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Building Codewind projects</span> |
| </div> |
| </a> |
| <a href="mdteclipsedebugproject" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Debugging Codewind projects</span> |
| </div> |
| </a> |
| <a href="mdteclipsetroubleshooting" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Troubleshooting</span> |
| </div> |
| </a> |
| <a href="mdteclipseuninstall" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Uninstalling</span> |
| </div> |
| </a> |
| </div> |
| |
| <a href="#codewind_for_vscode" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Codewind for VS Code</span> |
| <span class="submenu-icon ml-auto"></span> |
| </div> |
| </a> |
| <div id="codewind_for_vscode" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| <a href="mdt-vsc-overview" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Overview</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-getting-started" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Getting started</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-tutorial" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Tutorial</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-commands-overview" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Commands overview</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-commands-project" |
| |
| |
| class="cw-current-page bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Project commands</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-commands-restart-and-debug" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Restart and debug commands</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-troubleshooting" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Troubleshooting</span> |
| </div> |
| </a> |
| <a href="mdt-vsc-uninstall" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Uninstalling</span> |
| </div> |
| </a> |
| </div> |
| |
| <a href="#configuring_codewind" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Configuring Codewind</span> |
| <span class="submenu-icon ml-auto"></span> |
| </div> |
| </a> |
| <div id="configuring_codewind" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| <a href="usingadifferenttemplate" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Using a template repository of your own</span> |
| </div> |
| </a> |
| |
| </div> |
| |
| <a href="guide_performance" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Guide: Monitoring applications with the performance dashboard</span> |
| </div> |
| </a> |
| |
| <a href="uninstall" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Uninstalling Codewind</span> |
| </div> |
| </a> |
| |
| <a href="troubleshooting" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Troubleshooting</span> |
| </div> |
| </a> |
| |
| <a href="limitations" |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Limitations</span> |
| </div> |
| </a> |
| |
| <!-- END hard coded TOC --> |
| |
| <!-- Separator without title --> |
| <li class="list-group-item cw-sidebar-separator-title bg-light cw-text-gray d-flex align-items-center menu-collapsed"> |
| <small class="badge badge-success cw-margin-auto">HELPFUL |
| LINKS</small> |
| </li> |
| <!-- /END Separator --> |
| <a href="https://projects.eclipse.org/proposals/eclipse-codewind" class="bg-light list-group-item list-group-item-action"> |
| <div class="d-flex w-100 justify-content-start align-items-center"> |
| <span class="menu-collapsed">Eclipse Codewind project page</span> |
| </div> |
| </a> |
| <!-- Logo --> |
| <li class="list-group-item cw-logo-separator bg-light d-flex justify-content-center"> |
| <img src="images/header-logo.svg"> |
| </li> |
| </ul> |
| <!-- List Group END--> |
| </div> |
| <!-- sidebar-container END --> |
| <!-- MAIN --> |
| <div id="content-container" class="py-5 px-5"> |
| <div role="main"><h1 id="project-commands-codewind-for-vs-code">Project commands: Codewind for VS Code</h1> |
| |
| <h3 id="see-also"><strong>See also:</strong></h3> |
| <ul> |
| <li><a href="mdt-vsc-commands-overview">Commands overview</a></li> |
| <li><a href="mdt-vsc-commands-restart-and-debug">Restart and debug</a></li> |
| </ul> |
| |
| <hr /> |
| |
| <h2 id="create-a-new-project-or-work-with-an-existing-project">Create a new project or work with an existing project</h2> |
| |
| <ul> |
| <li>To create a new project, right-click the <em>Projects (Local)</em> item and select <strong>Create New Project</strong>, or click on the <em>+</em> icon beside the <em>Projects (Local)</em> item. You can also create a new project using the <strong>Command Palette</strong>.</li> |
| <li>To work with an existing project, right-click the <em>Projects (Local)</em> item and select <strong>Add Existing Project</strong>, or click on the <em>link</em> icon beside the <em>Projects (Local)</em> item. You can also add an existing project using the <strong>Command Palette</strong>. Note that the project must already exist within the <em>codewind-workspace</em> folder.</li> |
| </ul> |
| |
| <p>Right-click a project in the <strong>Codewind view</strong> to see most project commands. All commands are available in the <strong>Command Palette</strong>.</p> |
| |
| <h2 id="commands">Commands</h2> |
| |
| <h3 id="open-in-browser"><strong>Open in browser</strong></h3> |
| <p>Open the project application root endpoint in the system browser. The project must be in the <em>Running</em> or <em>Debugging</em> state, or the application server won’t be available.</p> |
| |
| <h3 id="open-application-monitor"><strong>Open application monitor</strong></h3> |
| <p>Open the Codewind <strong>Application Monitor</strong> page for this project in the system browser.</p> |
| |
| <h3 id="open-folder-as-workspace"><strong>Open folder as workspace</strong></h3> |
| <p>Open the project as your VS Code workspace folder. This command is useful if you want to work on just one project at a time per window. If you want the folder to open in a new window, set <em>window.openFoldersInNewWindow</em> to <strong>true</strong>.</p> |
| |
| <h3 id="show-project-overview"><strong>Show project overview</strong></h3> |
| <p>Open an editor tab that displays all of the Codewind information for the project. From this page, you can build, disable, or delete the project, and you can change the project auto build setting. This page is the only place in the extension where you can delete a project. If you delete a project, you remove it from both Codewind and from your file system.</p> |
| |
| <h3 id="build"><strong>Build</strong></h3> |
| <p>Manually request an application build for this project. If the project has auto build enabled, this command should not be necessary because builds are triggered automatically with a code change. This command is also available in the project info page. |
| This command is equivalent to clicking the <strong>Build</strong> button in the Codewind <strong>Overview</strong> page.</p> |
| |
| <h3 id="toggle-auto-build"><strong>Toggle auto build</strong></h3> |
| <p>Enable or disable auto build for the project. This command is also available in the project info page. This command is equivalent to clicking the <strong>Auto Build</strong> toggle in the Codewind <strong>Overview</strong> page.</p> |
| |
| <h3 id="open-container-shell"><strong>Open container shell</strong></h3> |
| <p>Open a shell, either <em>bash</em> or <em>sh</em>, in the project application container with <em>docker exec</em>. The project must have a container running. The VS Code integrated terminal needs access to your <em>PATH</em> environment variable so that it can run the <em>docker</em> command.</p> |
| |
| <h3 id="enable-or-disable-project"><strong>Enable or disable project</strong></h3> |
| <p>Enable or disable the project. This command is also available in the project info page.<br /></p> |
| |
| <h2 id="logs">Logs</h2> |
| |
| <h3 id="show-all-logs"><strong>Show all logs</strong></h3> |
| <p>Open a channel in the <strong>Output</strong> view for each of the project’s logs. To remove the output channel, use the <strong>Hide logs</strong> command.</p> |
| |
| <h3 id="hide-all-logs"><strong>Hide all logs</strong></h3> |
| <p>This command hides all the output channels that contain logs for this project.</p> |
| |
| <h3 id="manage-logs"><strong>Manage logs</strong></h3> |
| <p>This command presents a list of all logs for this project, which you can toggle individually.</p> |
| |
| <h2 id="project-specific-settings">Project-specific settings</h2> |
| <p>Edit the internal app and debug ports as well as the <strong>application endpoint</strong>, sometimes known as the <strong>context root</strong>, from the <strong>Project Overview</strong> page.</p> |
| |
| <hr /> |
| |
| <p><a href="mdt-vsc-commands-restart-and-debug">Next: Restart and debug</a></p> |
| |
| <p><a href="mdt-vsc-commands-overview">Back to the commands overview</a></p> |
| |
| <p><a href="mdt-vsc-overview">Back to the VS Code tools overview</a></p> |
| |
| <p><a href="mdt-vsc-troubleshooting">Troubleshooting</a></p> |
| </div> |
| </div> |
| </div> |
| <!-- Main Col END --> |
| <!-- footer row --> |
| <footer> |
| <div class="row" id="footer-div"> |
| <div class="col-lg-3 col-md-3 footer-col text-center"> |
| <div> |
| <div> |
| <a href="https://twitter.com/EclipseCodewind"><img src="images/twitter-logo.svg" class="cw-logo" /></a> |
| </div> |
| <div>@EclipseCodewind</div> |
| </div> |
| </div> |
| |
| <div class="col-lg-3 col-md-3 footer-col text-center"> |
| <div> |
| <div> |
| <a href="https://github.com/eclipse/codewind"><img src="images/github-logo.svg" |
| class="cw-logo" /></a> |
| </div> |
| <div>@Codewind</div> |
| </div> |
| </div> |
| <div class="col-lg-3 col-md-3 footer-col text-center"> |
| <div> |
| <div> |
| <a href="mailto:codewind-dev@eclipse.org"><img src="images/email-icon.svg" class="cw-logo" /></a> |
| </div> |
| <div>@Codewind</div> |
| </div> |
| </div> |
| |
| <div class="col-lg-3 col-md-3 footer-col text-center"> |
| <div class="cw-logo-mm" > |
| <div class="cw-logo-mm" > |
| <a href="mailto:codewind-dev@eclipse.org"><img src="images/mattermost-logo.png" class="cw-logo-mm" /></a> |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| </footer> |
| <!-- footer row END --> <!-- Jquery --> |
| <script |
| src="https://code.jquery.com/jquery-3.4.1.min.js" |
| integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" |
| crossorigin="anonymous"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" |
| integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"> |
| </script> |
| |
| |
| |
| <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" |
| integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"> |
| </script> |
| |
| |
| <!-- Font Awesome JS --> |
| <script defer src="https://use.fontawesome.com/releases/v5.0.13/js/solid.js" |
| integrity="sha384-tzzSw1/Vo+0N5UhStP3bvwWPq+uvzCMfrN1fEFe+xBmv1C/AtVX5K0uZtmcHitFZ" crossorigin="anonymous"> |
| </script> |
| <script defer src="https://use.fontawesome.com/releases/v5.0.13/js/fontawesome.js" |
| integrity="sha384-6OIrr52G08NpOFSZdxxz1xdNSndlD4vdcf/q2myIUVO0VsqaGHJsB0RaBE01VTOY" crossorigin="anonymous"> |
| </script> |
| <!-- Place this tag in your head or just before your close body tag. --> |
| <script async defer src="https://buttons.github.io/buttons.js"></script> |
| |
| <script src="js/jquery.matchHeight-min.js"></script> |
| <script src="js/index.js"></script> |
| <script src="js/docs.js"></script> |
| |
| </div> |
| </body> |
| |
| </html> |
