Getting started

OpenWolf adds local project memory and context tools to your coding agent. It stores notes, a project map and session data in .wolf/.

These instructions cover OpenWolf 2.5.2. Check the published npm version and release record before using new commands.

Install the published package

Use Node.js 20 or later on Linux, macOS or Windows.

npm install -g openwolf
cd your-project
openwolf init

init detects installed agents, creates project files and scans eligible source files. To select agents yourself:

openwolf init --agent claude codex opencode

Grok Build can use --agent grok with enabled Claude-compatible hooks. Cursor, Gemini CLI and Antigravity receive project instructions only. See agent hook coverage.

Check the installation

openwolf --version
openwolf status
openwolf operations doctor

Start a new agent session. Complete any project or hook trust review required by that agent. For Codex, project hooks must be enabled in the installed Codex version. OpenWolf preserves existing settings and reports configuration problems it cannot safely repair.

Use the project map

openwolf find validateToken
openwolf find --file src/auth.ts
openwolf map --focus auth

These commands help locate relevant files and symbols before reading source text. Missing or stale entries may need a new scan:

openwolf scan

Review usage and activity

openwolf dashboard
openwolf usage report --json

The dashboard starts a local daemon if needed. It shows memory, project state, available usage records and hook health. Token records may be incomplete if the agent did not save the required data. Model cost estimates are separate from your subscription bill.

Save work for another session

A checkpoint can hold the objective, completed work, unresolved problems and next action. Handover packets can transfer selected saved Claude or Codex evidence into an explicit receiving session. Follow the handover workflow for export, inspection and import.

Saved evidence does not grant permission to run commands. Automatic durable instruction injection requires independent administrator approval and a protected installation. Regular project maps, checkpoints and activity reporting do not require that setup.

Share project notes

The generated .wolf/.gitignore excludes machine-local runtime data. Review both the ignore rules and file contents before committing project notes, bug records or the project map. Automated sensitive-file detection does not replace that review.

For existing projects, follow update and restore.