Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Visual Studio Code (in short: VS Code) is a free resource editor which works nicely together with the pi tool and simplifies customizing PIPEFORCE. You can also use a different editor but we recommend to use this one at least for the starting phase.

Table of Contents

Download and Installation

You can download Visual Studio Code for free here: https://code.visualstudio.com/download

Loading the workspace in VS Code

After you have created a new PIPEFORCE customization workspace, navigate to its location which looks similar to this (could differ depending on your operating system):

...

This will start Visual Studio Code with everything already setup, so you can immediately start to create and deploy customizations in PIPEFORCE:

...

Show the terminal

Its comfortable to also show the terminal inside of VS Code. To do so, in the top menu click Terminal → New Terminal. This opens a new terminal at the bottom of VS Code:

...

Create a new resource using a template

You can now use the terminal to create for example a new pipeline by typing in this command line in the VS Code terminal:

...

If you open this file, you can see it contains a simple hello world demo pipeline which logs “Hello World” into the server log and writes it into the body.

...

Executing a pipeline using the VS Code terminal

To run the pipeline right from within your VS Code use this command line:

...

You should then see the output of this pipeline in the terminal.

Enable code completion for pipelines

In order to enable code completion for pipelines inside of VS Code, you can optionally install the free YAML plugin from the Microsoft VS Code marketplace.

...

To test it, add a new command in the helloworld.pi.yaml file. After you started typing you should get a suggestion list of all available pipeline commands including inline documentation:

...

Uploading resources into the property store

After you have created a resource locally, you can upload it to the property store with a simple command line:

...