Installation

Step 1: Install Node.js

SUSHI requires Node.js. To install Node.js, go to https://nodejs.org/ and select the “LTS” download. If the download is not appropriate for your operating system, click the “Other Downloads” link to get a full list of downloads. Once the installer is downloaded, run it using the default options.

Ensure that Node.js is correctly installed by opening a command window and typing the following two commands. Each command should return a version number.

 node --version
 npm --version

Step 2: Install SUSHI

To install SUSHI, open up a command prompt and type the following command:

 npm install -g fsh-sushi

Check the installation via the command below:

 sushi -h

If the command outputs instructions on using the SUSHI command line interface (CLI), you’re ready to run SUSHI.

Use sushi -v to display the installed version of SUSHI and the version of the FSH specification it supports. SUSHI follows the semantic versioning convention (MAJOR.MINOR.PATCH):

  • MAJOR: A major release has significant new functionality and, potentially, grammar changes or other non-backward-compatible changes.
  • MINOR: Contains new or modified features, while maintaining backwards compatibility within the major version.
  • PATCH: Contains minor updates and bug fixes, while maintaining backwards compatibility within the major version.

Reverting SUSHI

To revert to a previous version of SUSHI, run:

 npm install -g fsh-sushi@{version}

where the {version} is replaced by the desired MAJOR.MINOR.PATCH version (e.g., npm install -g fsh-sushi@0.16.0).


Last modified November 13, 2020: Update documentation for 1.0.0 (#27) (f5a6fcd)