Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.webapp.io/llms.txt

Use this file to discover all available pages before exploring further.

Ghost Inspector allows you to easily create automated browser tests for your websites and web applications. Ensure everything works and looks the way it should. No coding required. Using the npx command that comes with Node.js you can run a command using the Ghost Inspector CLI without having to install it first. By default the Ghost Inspector CLI will exit successfully even if a suite or test fails, but you can use the --errorOnFail flag to exit unsuccessfully and fail the build.

​
Example Layerfile

Layerfile
# Expose the Ghost Inspector API key as an environment variable
SECRET ENV GHOST_INSPECTOR_API_KEY

# Run your Ghost Inspector suite
# Replace (suite ID) with the appropriate Ghost Inspector suite ID
RUN npx ghost-inspector suite execute (suite ID) \
  --apiKey=$GHOST_INSPECTOR_API_KEY \
  --startUrl=$EXPOSE_WEBSITE_HOST \
  --errorOnFail

​
Setting up Ghost Inspector with webapp.io

Your Ghost Inspector API key can be found on the main page of your Ghost Inspector account. This can then be stored and accessed using webapp.io’s secrets manager, under the name GHOST_INSPECTOR_API_KEY. More information on how to integrate Ghost Inspector with your webapp.io pipeline, including how to configure notifications can be found here.