01-installation.md

Installation

For many, the easiest way to install Prism is as a node module.

npm install -g @stoplight/prism-cli
# or
yarn global add @stoplight/prism-cli

Executable Binaries

For users without Node and/or NPM/Yarn, we provide standalone binaries for all major platforms. The quickest way to install the appropriate package for your operating system is via this shell script:

curl -L https://raw.githack.com/stoplightio/prism/master/install | sh

The binaries do not auto-update, so you will need to run it again to install new versions.

Docker

Prism is available as a Docker image. We recommend specifying the major version you'd like to use as a tag:

docker run --init -p 4010:4010 stoplight/prism:4 mock -h 0.0.0.0 api.oas2.yml

If the document you want to mock is on your computer, you'll need to mount the directory where the file resides as a volume:

docker run --init --rm -v $(pwd):/tmp -p 4010:4010 stoplight/prism:4 mock -h 0.0.0.0 "/tmp/file.yaml"

If you want to start the proxy server, you can run a command like this:

docker run --init --rm -d -p 4010:4010 -v $(pwd):/tmp -P stoplight/prism:4 proxy -h 0.0.0.0 "/tmp/file.yml" http://host.docker.internal:8080 --errors

Now everything is installed, let's look at some of the concepts.