vulkro-sf docs
Generates a Markdown data dictionary of the project's custom objects and fields, with where each field is used.
vulkro-sf docs . --output DATA_DICTIONARY.md
vulkro-sf docs . --format json > dictionary.json
The document has three parts:
- Objects: one section per custom object, listing each custom field's API name, type, label and description.
- Lineage: per field, where it is used. Fields nothing references are marked as candidate-unused.
- Reference chains: formula fields and validation rules whose formula references a candidate-unused field or crosses many objects.
This is documentation, not a security scan. Lineage is best-effort: dynamic SOQL, managed packages and live-org wiring are invisible to static source, so "no reference found" is a candidate, never proof. No org connection is needed.
| Flag | What it does |
|---|---|
[PATH] | SFDX project or retrieved metadata. Default .. |
--output <file> | Write to this file instead of stdout. The folder must exist. |
--format <markdown|json> | Output format. Default markdown. |
Exit codes
| Code | Meaning |
|---|---|
0 | A dictionary was rendered. |
1 | No custom fields found: the dictionary is empty. |
2 | Error (unscannable path, unwritable --output, unknown --format). |