FBFolderbaseDOCS
Reference

CLI reference

Discover the Folderbase command surface and its stable machine-readable interface.

The folderbase executable is the reference interface to Folderbase Core.

Discover commands

folderbase --help
folderbase --help-json
folderbase protocol contract --json

--help-json is the machine-readable command inventory. Callers should discover the available surface rather than parse human help text.

Primary command families

CommandPurpose
inspectRead folder metadata and boundaries without mutation.
initPreview or add the Folderbase protocol surface.
validateCheck protocol records and report diagnostics.
migratePlan and execute reviewed restructuring through a durable transaction.
workspaceList, read, and save ordinary workspace files.
protocolAdvertise compatibility and integration contracts.

Machine-readable calls

Use --json on supported commands. Successful JSON output is written to stdout. Diagnostics and progress that are not part of the result belong on stderr.

See CLI JSON v1 for the compatibility rules.

On this page