KrypticKryptic Docs

Configuration reference

Updated

kryptic.json

The per-repository project file. It contains no secrets and is committed to version control. Every package finds it by walking up from the current working directory, so it also works from subdirectories and monorepo packages.

{
  "projectId": "proj_a1b2c3d4e5f6",
  "defaultEnvironment": "development"
}
  • Name
    projectId
    Type
    string
    Required
    required
    Enum
    Description

    The project's public id (proj_ + 12 hex characters), shown on the project page in the dashboard. Identifies which project's secrets to fetch.

  • Name
    defaultEnvironment
    Type
    string
    Required
    optional
    Enum
    Description

    The environment the daemon serves when nothing overrides it. Defaults to development.

Environment variables

Every package honors the same set - environment variables always win over kryptic.json and over options passed in code.

  • Name
    KRYPTIC_PROJECT_ID
    Type
    string
    Required
    optional
    Enum
    Description

    Override the project id from kryptic.json.

  • Name
    KRYPTIC_ENV
    Type
    string
    Required
    optional
    Enum
    Description

    Override the environment to fetch (e.g. staging).

  • Name
    KRYPTIC_SOCKET_PATH
    Type
    string
    Required
    optional
    Enum
    Description

    Override the daemon endpoint. Default: /tmp/kryptic-daemon.sock on macOS, $XDG_RUNTIME_DIR/kryptic-daemon.sock on Linux, \\.\pipe\kryptic-daemon on Windows. Tests use this to point packages at a mock daemon.

  • Name
    KRYPTIC_TIMEOUT_MS
    Type
    number
    Required
    optional
    Enum
    Description

    Daemon connection timeout in milliseconds. Default 2000.

  • Name
    KRYPTIC_DISABLED
    Type
    boolean
    Required
    optional
    Enum
    Description

    true force-disables injection everywhere, before any socket I/O.

  • Name
    KRYPTIC_SILENT
    Type
    boolean
    Required
    optional
    Enum
    Description

    true suppresses the one-line warning when the daemon is absent.

Packages are development-only by design: each one checks its runtime's idiomatic environment signal (NODE_ENV, ASPNETCORE_ENVIRONMENT, RAILS_ENV, CPP_ENV, …) and becomes a no-op in production and staging.

Daemon variables

  • Name
    KRYPTIC_API
    Type
    string
    Required
    optional
    Enum
    Description

    Point the daemon at a self-hosted platform (default https://daemon.kryptic.dev).