| name | flub-reference |
| description | Quick reference for flub and fluid-build CLI commands in the Fluid Framework monorepo. Use when you need to find the right flub command, understand its flags, or figure out how to run a specific build/check/generate task. Triggers on mentions of flub, fluid-build, build CLI, or specific flub subcommands. |
flub & fluid-build Command Reference
Quick reference for the Fluid Framework build CLI tools.
Two Tools
flub (@fluid-tools/build-cli) — Package management, code generation, releases, policy checks
fluid-build (@fluidframework/build-tools) — Build orchestration, task execution, dependency-aware compilation
fluid-build
Build orchestrator used by pnpm build, pnpm test, etc.
fluid-build [options] [<package-pattern>|<path>...]
Targeting Packages
fluid-build packages/dds/map
fluid-build --filter @fluidframework/map
fluid-build -g client
fluid-build .
Common Tasks
fluid-build . --task build
fluid-build . --task compile
fluid-build . --task api
fluid-build . --task lint
fluid-build . --task test
fluid-build . --task test:mocha
fluid-build . --task test:jest
fluid-build . --task clean
Useful Flags
| Flag | Purpose |
|---|
--task <name> / -t | Task to run |
--worker | Use worker threads for parallelism |
--filter <pkg> | Target specific package |
-g <group> | Target release group |
--vscode | Output for VS Code problem matcher |
flub Commands
Global Flags
| Flag | Purpose |
|---|
-v, --verbose | Verbose logging |
--quiet | Suppress output |
--json | JSON output |
Package Selection Flags (available on most commands)
| Flag | Purpose |
|---|
-g, --releaseGroup | client, server, azure, build-tools, gitrest, historian, all |
-p, --package | Specific package name |
--all | All packages and release groups |
--dir | Package directory path |
--changed | Only packages changed vs. branch |
--[no-]private | Include/exclude private packages |
--scope | Package scopes to include |
--skipScope | Package scopes to exclude |
flub info
Get repo, release group, and package information.
flub info
flub info -g client
flub info -c name,version,path
flub list
List packages in topological order.
flub list client
flub list client --feed public
flub list client --no-private
flub list client --outFile list.txt
flub check
check policy
Verify and fix repo policies (headers, assert tags, etc.).
flub check policy
flub check policy --fix
flub check policy --listHandlers
flub check policy -d "Handler"
flub check policy -p "packages/dds"
check changeset
Verify a changeset exists (CI use).
flub check changeset --branch main
flub check changeset --branch main --json
check layers
Validate dependency layering.
flub check layers --info layerInfo.json
flub check layers --info layerInfo.json --md .
flub check layers --info layerInfo.json --dot .
check buildVersion
Verify version consistency.
flub check buildVersion -g client --path .
flub check buildVersion -g client --path . --fix
flub generate
generate entrypoints
Create filtered .d.ts files per release tag level.
flub generate entrypoints --outDir ./lib --node10TypeCompat
flub generate entrypoints --outDir ./dist
| Flag | Purpose |
|---|
--mainEntrypoint | Main source file (default: ./src/index.ts) |
--outDir | Output directory |
--outFileAlpha, --outFileBeta, --outFilePublic | Override output names |
--outFileLegacyBeta, --outFileLegacyAlpha | Legacy variant names |
--node10TypeCompat | Node10 resolution compatible output |
generate changeset
Create a new changeset interactively.
flub changeset add --releaseGroup client
flub generate changeset -g client
flub generate changeset --empty
flub generate changeset --branch next
flub generate changeset --all
generate typetests
Generate type compatibility test files.
flub generate typetests --dir . -v
flub generate typetests --entrypoint public
flub generate typetests --publicFallback
generate releaseNotes
Generate release notes from changesets.
flub generate releaseNotes -g client -t minor
flub generate releaseNotes -g client -t major --outFile RELEASE.md
generate upcoming
Summarize all pending changesets.
flub generate upcoming -g client -t minor
generate assertTags
Tag assert statements with unique IDs.
flub generate assertTags --all
flub generate assertTags --validate
generate buildVersion
Compute CI version numbers.
flub generate buildVersion --build 12345 --release prerelease
generate bundleStats
Collect bundle analysis artifacts.
flub generate bundleStats --smallestAssetSize 100
generate compatLayerGeneration
Update compatibility layer generation state.
flub generate compatLayerGeneration --generationDir ./src
flub typetests
Update type test configuration in package.json.
flub typetests --dir . --reset --previous --normalize
flub typetests --dir . --disable
flub typetests --dir . --enable
flub typetests --dir . --exact 2.80.0
flub typetests --dir . --remove
flub bump
Version bumping.
flub bump client -t minor
flub bump client -t patch --commit --install
bump deps
Update external dependency versions.
flub bump deps client -t minor
flub bump deps client --prerelease
flub release
Release management (state machine driven).
flub release -g client -t minor
flub release prepare -g client
flub release history -g client -l 10
flub release report -g client
flub release fromTag client_v2.90.0
flub modify
modify fluid-imports
Rewrite imports to use correct subpaths.
flub modify fluid-imports --tsconfigs ./tsconfig.json
flub modify fluid-imports --onlyInternal
flub exec
Run shell commands across packages.
flub exec -g client -- npm run clean
flub exec --changed -- npm test
Common Recipes
Full rebuild of a single package
cd packages/dds/map
fluid-build . --task clean && fluid-build . --task build
Regenerate API reports after changing exports
fluid-build . --task api
Check everything locally before pushing
fluid-build . --task compile && npm run check:exports && npm run build:api-reports
Prepare for a PR
pnpm format:changed:main
pnpm check:changesets
flub check policy