11 KiB
11 KiB
DocForge command reference
Generated from the live CLI parser and MCP registrations. Do not edit this file by hand.
Global CLI options are documented in docforge --help and are not repeated in each command row. The MCP table is the complete generic application-enabled surface; the fixed reference-adapter server exposes only its read rows.
CLI commands
| Command | Invocation |
|---|---|
apply |
docforge apply [-h] --changeset-hash CHANGESET_HASH --applier APPLIER changeset_id |
backlinks |
docforge backlinks [-h] [--relation RELATION] [--limit LIMIT] node_id |
build |
docforge build [-h] |
check |
docforge check [-h] |
configure |
docforge configure [-h] --project PROJECT [--name NAME] [--capability-mode {read,proposal,application}] [--proposal-writer PROPOSAL_WRITER] [--canonical-applier CANONICAL_APPLIER] [--no-ast] [--manual-render-policy {auto,explicit,disabled}] [--portable-graph-policy {explicit,disabled}] [--live-viewer-policy {on-demand,disabled}] [--startup-timeout STARTUP_TIMEOUT] [--tool-timeout TOOL_TIMEOUT] [--output OUTPUT] {codex,claude,openclaw} |
context |
docforge context [-h] [--budget BUDGET] [--limit LIMIT] [--cursor CURSOR] profile |
dependencies |
docforge dependencies [-h] [--depth DEPTH] [--limit LIMIT] node_id |
doctor |
docforge doctor [-h] --client {codex,claude,openclaw} [--project PROJECT] [--config CONFIG] [--server-name SERVER_NAME] |
filter |
docforge filter [-h] [--family FAMILY] [--authority AUTHORITY] [--status STATUS] [--tag TAG] [--limit LIMIT] |
generation-diff |
docforge generation-diff [-h] [--limit LIMIT] [--cursor CURSOR] |
graph-plan |
docforge graph-plan [-h] view_id |
graph-render |
docforge graph-render [-h] view_id |
graph-render-status |
docforge graph-render-status [-h] [view_id] |
impact |
docforge impact [-h] [--depth DEPTH] [--limit LIMIT] node_id |
info |
docforge info [-h] |
onboard |
docforge onboard [-h] [--language LANGUAGE] [--scaffold] [--project-id PROJECT_ID] [--title TITLE] [--content-root CONTENT_ROOT] |
preview |
docforge preview [-h] changeset_id view_id |
reindex |
docforge reindex [-h] |
render |
docforge render [-h] view_id |
render-status |
docforge render-status [-h] [--deep] [view_id] |
search |
docforge search [-h] [--limit LIMIT] query |
show |
docforge show [-h] node_id |
sync |
docforge sync [-h] |
validate |
docforge validate [-h] |
validate-index |
docforge validate-index [-h] |
visualization-status |
docforge visualization-status [-h] |
visualization-stop |
docforge visualization-stop [-h] |
visualize |
docforge visualize [-h] [--node NODE | --query QUERY] [--depth DEPTH] [--no-open] |
MCP tools
| Surface | Tool | Required arguments | Optional arguments | Input schema SHA-256 | Description |
|---|---|---|---|---|---|
| read | docforge_backlinks |
node_id |
limit, relation |
bf9a5936e2d1ee70897dc0795ec9d716be63c9447e6fdcd3890d5dd92f45f690 |
Return bounded incoming relationships for one exact stable node. |
| read | docforge_bootstrap |
— | — | af6c17a59a7713cfb4497f0f66b05efc091abbfe109573bb86d673e39b9b7413 |
Synchronize and report the complete fixed project binding and workflow. |
| read | docforge_dependencies |
node_id |
depth, limit |
1283a8a030cf9369493a13e2aa87317d371470904a397910bc0b52997b3ec3b8 |
Traverse declared depends_on relationships within the configured depth limit. |
| read | docforge_filter_nodes |
— | authority, family, limit, status, tag |
2a51c4d8f4d76d89a2e7f90b3b06d14c7e16303b9c81e62af6747286b58cf68b |
Filter current nodes deterministically by validated metadata. |
| read | docforge_get_context |
profile |
budget, cursor, limit |
2f164828c2891a88d0ea7173790a72cc6f3da1279f14da2ca495e8989880b298 |
Compile bounded cited context from one configured profile with explicit omissions. |
| read | docforge_get_contract |
— | — | 19eb6785523ed9db645d17f61df2b8b584ac10ad308199e9a96e6e176a87169e |
Report canonical and derived boundaries plus allowed and excluded operations. |
| read | docforge_get_generation_diff |
— | cursor, limit |
0a2fccfea4bf5d78481d40b49e7c812ded9fbe9c93cb79296ede78f22b259fcf |
Return the latest bounded primary-graph generation transition. |
| read | docforge_get_logic |
owner_node_id |
— | 56909ee4d72143b470528ea2b3544325e1e1920dbcc758f3caee4a4924f904a1 |
Return the lazy control-flow projection owned by one function or method. |
| read | docforge_get_node |
node_id |
— | 52408b0c3a297e7b5cf96b293fd6d4625f05c4b090c02bfe806d25ce6c2d1c68 |
Return one exact stable node from the current validated project index. |
| read | docforge_get_task_context |
task, task_kind |
budget, cursor, focus_node_id, limit |
0ffbc030bbe5cca2ae24920ec812ac976be9090da4fa2887d87526aba64a21f7 |
Return one bounded task-shaped context capsule with explicit evidence gaps. |
| read | docforge_graph_plan |
view_id |
— | 7a014ba692f57badca9ca2098b88f82f4749ada6d71f5a3b8bc141abc86645f9 |
Plan one declared portable graph without publishing derived output. |
| read | docforge_graph_render_status |
— | view_id |
1d2f3604b0151ba2e228cc6ce1829d7f4244193b53d85df46eb6a3e608c59564 |
Report portable-graph publication state without rendering. |
| read | docforge_impact |
node_id |
depth, limit |
1c71db5bb4e1afe180d98dd5000a757b7e3fd1a048b5f68af13d9b7ac56e2ce2 |
Traverse bounded incoming relationships and report exact paths. |
| read | docforge_project_info |
— | — | a42973543d5e6f4147953d175f6aec43d228cd6bd1a63f3ca4e84a51ad7e8a64 |
Report the fixed project identity, revision, source hash, and index health. |
| read | docforge_render_status |
— | deep, view_id |
5ea5683bd74e685d4cabb1c960a66eff23a001bd2c68e1af350c6e46e936b9fd |
Report receipt state, or explicitly recompute the side-effect-free render oracle. |
| read | docforge_search |
query |
limit |
735fff8bd82b20730b0907db8bf61eb0de9fff240ef4fa239ce555779ae49047 |
Run bounded lexical search over the current validated project index. |
| read | docforge_stop_visualization |
— | — | 066a6e34019f4abcd3523f24d9e447775e1479adbea1134341f434a6bb5f8d35 |
Explicitly stop this project's persistent read-only graph browser. |
| read | docforge_sync |
— | — | a2ac50c03b9b0e08b271216f76920279563ed264bef06d6791695c68dcb3b2a2 |
Ensure the disposable project index matches current canonical sources. |
| read | docforge_validate_project |
— | — | 3192ba97a6d7fff13008c5ed3bfa549d1eeea95332579592d96b8fd326ad06f7 |
Validate current canonical sources and graph without writing any project file. |
| read | docforge_visualization_status |
— | — | 03751f891e0a9318355a6b28be551eec6009c0f96f05ff99536e2f401b76f87f |
Report this project's managed graph browser lifecycle state. |
| read | docforge_visualize |
— | depth, node_id, query |
cdc9669ba934e591379ea684934d99e2e80ba3f181d6c58867774a8064c32f4b |
Start the fixed read-only graph browser for this configured project. |
| proposal | docforge_abandon_changeset |
changeset_id, expected_changeset_hash, reason |
— | 8813e40ffc12b1ae3d9abe73db8de214085a4a8042323146283fffa8f7476a62 |
Mark one proposal abandoned while preserving its audit record. |
| proposal | docforge_create_changeset |
changeset_id |
— | 0de93025b9caaa9e33b4b2b3bcfabdde087c944daba48dd77ae3c8f757c52ab8 |
Create an empty hash-bound proposal under the configured isolated changeset root. |
| proposal | docforge_get_changeset |
changeset_id |
cursor, limit |
919737a8e732cf95305a2964cddf98f1fdce9ce2cfb52ff659436c244a38495d |
Inspect a stored proposal even when its canonical base has become stale. |
| proposal | docforge_get_changeset_diff |
changeset_id |
cursor, limit |
5cc1d2b035f37e3866766cfa0c3541b144762b764bf455a641ab459df03f8a59 |
Return a deterministic structured and textual diff without applying the proposal. |
| proposal | docforge_list_changesets |
— | cursor, include_history, limit, status |
b96519477781cb20acbfc9502a4b7d64a9119e0bd8d71e27290e90677aaf9ced |
List active proposals by default, with optional lifecycle history. |
| proposal | docforge_preview_changeset |
changeset_id, view_id |
— | d84e1710a5cac52607037a7e581fcb221c42d3776f510eefe42fb6779fee7fb3 |
Render one validated changeset through a declared view into its isolated preview path. |
| proposal | docforge_propose_node_create |
changeset_id, content, expected_changeset_hash, metadata, node_id, rationale, relationship_changes, target_source |
— | 8953b502b9d8d9c097935bae51fce4e830286eace9df3cb6c37b7e0542be5a4e |
Append one validated node creation without writing its canonical target. |
| proposal | docforge_propose_node_delete |
changeset_id, expected_changeset_hash, expected_content_hash, node_id, rationale, relationship_changes |
— | 8fb6a22e5c1ead3793384652e4b61e75cc23c2725906542533a121401f7faaee |
Append one validated deletion with explicit incident relationship removals. |
| proposal | docforge_propose_node_move |
changeset_id, expected_changeset_hash, expected_content_hash, node_id, rationale, target_source |
— | 32ef6fc4b9795a6a8e30f4f81f63d84d7350e983773f796524382d71cb870a67 |
Append one validated same-format node move without moving a canonical file. |
| proposal | docforge_propose_node_update |
changeset_id, content, expected_changeset_hash, expected_content_hash, metadata, node_id, rationale, relationship_changes |
— | 6a29a73b9e50c9fe22cb6d056bbcdacef30c93c0822c8a9276ef33f9e51e7728 |
Append one validated node update without changing canonical content. |
| proposal | docforge_propose_relationship_update |
changeset_id, expected_changeset_hash, expected_content_hash, node_id, rationale, relationship_changes |
— | 8e21fc7ba35289940dd7f12294b14e8553163ab901002dcd4a3998cdb33556c3 |
Queue hash-bound relationship changes without rewriting node content. |
| proposal | docforge_rebase_changeset |
changeset_id, expected_changeset_hash |
— | 505434b2f9f611649221b95d0251db347c44752d1c73e5d69e1abfd916966788 |
Safely rebase a proposal when every touched fact remains unchanged. |
| proposal | docforge_register_changes |
changeset_id, operations |
— | c5a7d6ac07d3d3b95c13b0c57ad9b69360f2f063b1c8e22dd5f64f6d3a83dc5b |
Atomically register and validate a complete hash-bound proposal. |
| proposal | docforge_validate_changeset |
changeset_id |
cursor, limit |
cb9df5104dbefc3382900ec812ea581a43612d1577619071f1f03674041652c7 |
Validate a proposal against its exact canonical base and other active proposals. |
| application | docforge_apply_changeset |
changeset_id, expected_changeset_hash |
— | 80259f5001f36b14f960c10bd94751d1431077b72e081fb5a5c806b79073b085 |
Apply one exact validated changeset and refresh declared derived state. |