Argus
Contributing

Development

Bootstrap the pinned Node.js and pnpm toolchain, run Argus locally, and keep configuration and secrets out of commits.

Use Node.js 24.16.0 and pnpm 10.33.0. The root package manifest records the exact pnpm integrity-pinned version; use Corepack or another toolchain manager that honors it.

Bootstrap

corepack enable
pnpm install --frozen-lockfile
cp argus.example.yaml argus.yaml
cp .env.example .env
set -a
source .env
set +a
pnpm argus config validate
pnpm argus config apply
pnpm start

This starts the combined local runtime. The API is at http://localhost:8788; use the generated local API token only in your shell or local .env file.

Configuration and environment

argus.yaml is the versioned configuration input; .env is local-only. The supplied environment example names the runtime inputs:

VariablePurpose
ARGUS_CONFIGRuntime configuration path.
ARGUS_API_TOKENAPI bearer token.
OPENROUTER_API_KEYOptional OpenRouter credential for intelligence.
FXEMBED_ENDPOINTX source endpoint.

Never commit argus.yaml, .env, secrets.env, deployment state, test credentials, or release signing material. Do not put secret values in YAML fixtures, test transcripts, issue reports, or shell history. See security for the operator-facing secret boundary.

Everyday commands

pnpm lint
pnpm test
pnpm typecheck
pnpm build

Use pnpm argus --help to discover local CLI commands and pnpm argus --version to print the installed CLI version. For a production-like managed instance, follow the canonical installation and operations documentation rather than manually constructing Compose files or deployment state.

On this page