Skip to main content

​
Install via npm

After installation, verify it works:

​
Use without installing

Run any Griffin command with npx:

​
Initialize a project

Navigate to your project directory and run:
This creates a griffin.json configuration file in your project root. Griffin uses this to identify the project and track environments.
Griffin discovers monitor files in __griffin__/ directories anywhere in your project tree. You can organize monitors alongside the code they test.

​
Requirements

  • Node.js 18 or later
  • npm 8 or later
  • A __griffin__/ directory containing .ts monitor files

​
What’s next

Quickstart

Write and run your first API monitor.