Install CH5 Developer Tools

The following installation steps are provided for a basic installation of CH5 and setup of a sample project.

  1. Install Node.js®/NPM as described at https://nodejs.org.
  2. Install the Crestron utilities CLI (Command Line Interface) or update to the latest version:
    • On a Windows® operating system workstation, open the command prompt and issue the following commands:
      • Copy 
      npm install -g @crestron/ch5-utilities-cli 

      npm install -g @crestron/ch5-shell-utilities-cli 
    • On a macOS® operating system workstation, open the terminal and issue the following commands:
      • Copy 
      sudo npm install -g @crestron/ch5-utilities-cli

      sudo npm install -g @crestron/ch5-shell-utilities-cli
  3. Install Visual Studio® Code software by downloading and installing the binaries for Windows, macOS, and Linux® operating systems at https://code.visualstudio.com/Download.

    4. NOTE:  If Node.js/NPM or the Crestron utilities CLI is installed after Visual Studio Code is open, Visual Studio Code must be closed and reopened.

  4. Install CH5 Visual Studio Code Extension:

    5. NOTE: When a new version of CH5 is released, check to see whether there are any updates available to the CH5 Visual Studio Code Extension.

    1. Open Visual Studio Code.
    2. Open Extensions.
    3. Click the Extensions menu icon. Refer to number 2 in the image below.
    4. Enter the search term "Crestron" in the Search for Extensions in Marketplace text field. Refer to number 3 in the image below.
    5. Select Install from the CH5 Crestron Components extension result. Refer to number 4 in the image below.

    CH5 Crestron Components - Extension Marketplace