Skip to content

This only links to pages of the documentation. It does not write answers.

Set up TypeSafe

How-to guide

TypeSafe offers System One models like Jev, which answer typed questions directly with calibrated probabilities. That is what rules ask for, so this provider gives the most reliable findings, especially when you audit in CI.

  • Compass installed in your Starlight site.
  • A TypeSafe API key. Jev is in early access. Create a key in the TypeSafe console.
  1. Create a .env file in your project root with your API key. Make sure .env is listed in your .gitignore file.

    .env
    TYPESAFE_API_KEY=apikey_...
  2. Add the plugin with the typesafe() provider to your Starlight configuration:

    astro.config.mjs
    import starlight from "@astrojs/starlight";
    import { defineConfig } from "astro/config";
    import starlightCompass, { typesafe } from "starlight-compass";
    export default defineConfig({
    integrations: [
    starlight({
    plugins: [starlightCompass({ provider: typesafe() })],
    title: "My Docs",
    }),
    ],
    });

Pin a model version with typesafe({ model: "jev-1.13.0" }) to get the same answers over time. Next, review your first page.