Skip to content
Agent Detective

Staying up to date

Staying up to date

Section titled “Staying up to date”

Use this page when you deploy with the agent-detective npm CLI, track main in git, or consume published npm packages from this monorepo. It ties together GitHub Releases and migration.md.

Other operator hubs: installation.mdx (deploy paths) · configuration-hub.md (config load order and keys).

How to learn about changes

Section titled “How to learn about changes”
ChannelUse for
GitHub ReleasesVersion notes when the release-please Release PR merges (workflow)
migration.mdConfig moves and conventions (not a full version history)
Watching the repositoryGitHub Watch for releases or commits

There is no separate mailing list; subscribe via GitHub.

Upgrading the npm CLI

Section titled “Upgrading the npm CLI”

  1. Read GitHub Release notes since the version you run (and migration.md if linked).

  2. Update config if new or changed keys are required — see configuration-hub.md and configuration.md.

  3. Upgrade the global package:

    Terminal window
    npm i -g agent-detective@latest

  4. Restart the process (systemd, or your supervisor).

  5. Run agent-detective doctor and agent-detective smoke (server running) or GET /api/health.

Keep secrets in env (configuration.md); do not bake tokens into world-readable install trees.

Layout and systemd: deployment.md.

Upgrading from a git clone

Section titled “Upgrading from a git clone”

For operators who run pnpm start from a built tree:

Pull and rebuild from source
git fetch origin
git checkout <branch-or-tag>   # e.g. main or a release tag
pnpm install --frozen-lockfile
pnpm run build
pnpm run build:app
  1. Same as above: release notes + migration + config review.
  2. If you change bundled plugin Zod schemas in a fork, run pnpm docs:plugins and commit generated/plugin-options.md if you track it.
  3. Run tests in CI or locally: pnpm test, pnpm run typecheck (as in development.md).

Published npm packages (@agent-detective/*)

Section titled “Published npm packages (@agent-detective/*)”

Workspace packages may be published per publishing.md. When you depend on them in another project:

  • Follow semver in that package’s version.
  • Read the monorepo CHANGELOG when upgrading the app or library — types and plugin options can change together.

Summary

Section titled “Summary”

See also

Section titled “See also”