Documentation menu

Getting started

Use an existing project

Start by installing Flog, then open the repository root.

A project that already uses Flog#

If the repository has a committed flog.lock, run:

flog install

The same command is suitable for development and CI. It validates manifests and platform support against the lock, then materializes that exact graph. It never resolves newer versions or rewrites flog.lock.

If the lock is stale, review the intended dependency change rather than automatically regenerating it. See dependency installation.

Adopt Flog in an existing repository#

Flog uses your existing package.json. To resolve a Flog lock and install:

flog lock
flog install

This resolves from your declared dependency ranges; it does not import another package manager's lockfile. Review the resulting versions and test the project before committing flog.lock or changing your CI workflow.

Review lifecycle permissions as well: dependency scripts are controlled deliberately. See dependency installation.

Run project work#

flog run test
flog run build

These examples require the corresponding scripts in package.json. For graph-aware builds across source workspaces, use flog build instead.

Continue with scripts and binaries, packages and workspaces, or production and CI.