vscode-extension-samples/terminal-sample/README.md

vscode-terminal-api-example

This sample provides several commands that demonstrates how to utilize the integrated terminal extension API. Access the commands through the command palette (F1).

VS Code API

vscode module

• window.createTerminal
• window.onDidChangeActiveTerminal
• window.onDidCloseTerminal
• window.onDidOpenTerminal
• window.Terminal
• window.terminals

Proposed API

• window.createTerminalRenderer
• window.TerminalRenderer
• window.registerTerminalProfileProvider

Contribution Points

• contributes.commands
• contributes.terminal

Running the Sample

• Run npm install in terminal to install dependencies
• Run the Run Extension target in the Debug View. This will:
  • Start a task npm: watch to compile the code
  • Run the extension in a new VS Code window