{"result":{"depiction_url":null,"edges":{"in_module":{"objects":[{"created":"2026-11-11T09:19:20Z","object_id":{"id":1457,"is_a":["text","documentation","reference","module"],"name":"doc_module_mod_development","title":"mod_development","uri":"https:\/\/zotonic.com\/id\/1457"},"seq":1}],"predicate":{"id":333,"is_a":["meta","predicate"],"name":"in_module","title":{"_type":"trans","tr":{"en":"In module"}},"uri":"https:\/\/zotonic.com\/id\/in_module"}},"refers":{"objects":[{"created":"2026-11-11T12:17:45Z","object_id":{"id":3183,"is_a":["text","documentation","reference","model"],"name":"doc_model_model_development_capture","title":"development_capture","uri":"https:\/\/zotonic.com\/id\/3183"},"seq":1000000}],"predicate":{"id":2409,"is_a":["meta","predicate"],"name":"refers","title":{"_type":"trans","tr":{"en":"Refers"}},"uri":"https:\/\/zotonic.com\/id\/refers"}},"subject":{"objects":[{"created":"2026-11-11T09:19:20Z","object_id":{"id":2555,"is_a":["categorization","keyword","keyword_information_type"],"name":"zotonic_topic_reference","title":"Reference","uri":"https:\/\/zotonic.com\/id\/2555"},"seq":1},{"created":"2026-11-11T09:19:20Z","object_id":{"id":2563,"is_a":["categorization","keyword","keyword_audience"],"name":"zotonic_topic_frontend_developer","title":"Frontend developer","uri":"https:\/\/zotonic.com\/id\/2563"},"seq":2},{"created":"2026-11-11T09:19:20Z","object_id":{"id":2564,"is_a":["categorization","keyword","keyword_audience"],"name":"zotonic_topic_backend_developer","title":"Backend developer","uri":"https:\/\/zotonic.com\/id\/2564"},"seq":3},{"created":"2026-11-11T09:19:20Z","object_id":{"id":2608,"is_a":["categorization","keyword","keyword_domain"],"name":"zotonic_topic_routing_and_redirects","title":"Routing and redirects","uri":"https:\/\/zotonic.com\/id\/2608"},"seq":4},{"created":"2026-11-11T09:19:20Z","object_id":{"id":2613,"is_a":["categorization","keyword","keyword_domain"],"name":"zotonic_topic_development_and_debugging","title":"Development and debugging","uri":"https:\/\/zotonic.com\/id\/2613"},"seq":5},{"created":"2026-11-11T09:19:20Z","object_id":{"id":2625,"is_a":["categorization","keyword","keyword_architecture"],"name":"zotonic_topic_model","title":"Model","uri":"https:\/\/zotonic.com\/id\/2625"},"seq":6}],"predicate":{"id":308,"is_a":["meta","predicate"],"name":"subject","title":{"_type":"trans","tr":{"en":"Keyword"}},"uri":"http:\/\/purl.org\/dc\/elements\/1.1\/subject"}}},"export_revision":23,"id":3182,"is_a":["text","documentation","reference","model"],"links":[{"rel":"self","target":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/3182"},{"rel":"hub","target":"https:\/\/zotonic.com\/.zotonic\/websub"}],"medium":null,"medium_url":null,"name":"doc_model_model_development_tools","page_url":{"en":"https:\/\/zotonic.com\/docs\/3182\/development_tools","x-default":"https:\/\/zotonic.com\/docs\/3182\/development_tools"},"preview_url":null,"resource":{"version":8,"pivot_location_lat":null,"title":"development_tools","is_authoritative":true,"body":"

Inspect a running site's dispatch rules, template resolution, source, composition,\nand available model APIs. Combine this model with model#development_capture<\/code><\/a>\nwhen conditional or lazy rendering needs runtime evidence.<\/p>\n

For local and remote workflows, see the\nLLM site development guide<\/a>.<\/p>\n

Access<\/h2>\n

All endpoints require an administrator with use mod_development<\/code> permission\nand a site environment of development<\/code>, test<\/code>, or acceptance<\/code>. Production\nis denied, including trusted CLI calls. Read-only administrators can use these\ninspection endpoints.<\/p>\n

Inspection does not render pages, edit source, or deploy changes. Template\ncomposition may compile an indexed template to obtain its metadata.<\/p>\n

Browser quick start<\/h2>\n

Authorized pages with the development head assets expose\nwindow.z_development_tools<\/code>. Inspection requires neither a capture attachment\nnor a visible debug button.<\/p>\n

const tools = window.z_development_tools;\nconst route = await tools.dispatchTrace();\nconst template = await tools.template('page.tpl', 'article_resource_name');\nconst source = await tools.templateSource('page.tpl', 'article_resource_name');\nconst composition = await tools.templateComposition('page.tpl', 'article_resource_name');\n<\/code><\/pre>\n
All methods return promises containing the model result. Model errors reject\nwith error.code<\/code>; transport failures also reject.<\/p>\n
JavaScript method<\/th>Result<\/th><\/tr><\/thead>
dispatch()<\/code><\/td>Active dispatch rules.<\/td><\/tr>
dispatchTrace(path?)<\/code><\/td>Dispatch trace for a local path; defaults to location.pathname<\/code>.<\/td><\/tr>
template(name, id?)<\/code><\/td>Winning template and indexed override candidates.<\/td><\/tr>
templateSource(name, id?, {candidate}?)<\/code><\/td>Selected candidate's metadata and UTF-8 source.<\/td><\/tr>
templateComposition(name, id?, {candidate}?)<\/code><\/td>Selected candidate's inheritance, local blocks, and literal includes.<\/td><\/tr>
templates({prefix, offset, limit}?)<\/code><\/td>Paginated indexed template names and winning locations.<\/td><\/tr>
modules()<\/code><\/td>Active modules and priorities.<\/td><\/tr>
models({prefix, offset, limit}?)<\/code><\/td>Paginated available models and exported callback methods.<\/td><\/tr>
modelDocumentation(name)<\/code><\/td>Model documentation, availability, transport patterns, and incomplete GET-path hints.<\/td><\/tr><\/tbody><\/table>\n
Template selection and source<\/h2>\n
Use relative indexed template names, never filesystem paths. The optional id<\/code>\nis a resource ID or name and applies the same category selection as catinclude<\/code>.\nLookup returns the resolved name<\/code>, winning filepath<\/code>, and candidates<\/code> in module\npriority order. Lower numeric priorities win.<\/p>\n
Source and composition accept a zero-based candidate<\/code> position from that list.\nOmit it for the winner; pass undefined<\/code> for the resource when selecting a candidate\nwithout category lookup:<\/p>\n
const current = await tools.templateSource('page.tpl');\nconst next = current.candidates.find(c => c.candidate === current.candidate + 1);\nif (next) {\n    const parent = await tools.templateSource(current.name, undefined, {\n        candidate: next.candidate\n    });\n}\n<\/code><\/pre>\n
Use the next candidate to follow {% overrules %}<\/code>. Each request resolves the\nindex afresh. Source results include source<\/code>, candidate<\/code>, module<\/code>, priority<\/code>,\nand winner_filepath<\/code>; filepath<\/code> identifies the file actually read. Source\nreading performs no rendering or compilation and is limited to 1 MiB of UTF-8.<\/p>\n
Static composition<\/h2>\n
Composition uses compiler metadata and may compile the selected file. It does\nnot render templates or evaluate runtime inheritance arguments.<\/p>\n
Field<\/th>Meaning<\/th><\/tr><\/thead>
inheritance<\/code><\/td>type<\/code> is none<\/code>, extends<\/code>, or overrules<\/code>; a resolved parent is in target<\/code>, or lookup failure in error<\/code>.<\/td><\/tr>
blocks<\/code><\/td>Names defined in this file, not inherited or effective blocks.<\/td><\/tr>
includes<\/code><\/td>Literal references with template<\/code>, line<\/code>, column<\/code>, method<\/code>, and is_catinclude<\/code>.<\/td><\/tr>
analysis<\/code><\/td>static<\/code>.<\/td><\/tr>
blocks_scope<\/code><\/td>local<\/code>.<\/td><\/tr>
includes_scope<\/code><\/td>literal_references<\/code>.<\/td><\/tr><\/tbody><\/table>\n
Include methods are normal<\/code>, optional<\/code>, or all<\/code>. Dynamic include names,\nconditional choices, and resource category selection at include call sites are\nnot resolved. Follow parent targets and include names with further lookups;\ntrack visited files to avoid cycles. A missing parent is reported in\ninheritance.error<\/code>; compilation errors fail the request.<\/p>\n
Discover model APIs<\/h2>\n
const models = await tools.models({prefix: 'rsc', offset: 0, limit: 50});\nconst api = await tools.modelDocumentation('rsc');\n<\/code><\/pre>\n
Model names omit m_<\/code>. Discovery includes core and active-site models, honoring\nthe site's effective resolution and core-model precedence. Entries identify\nname<\/code>, erlang_module<\/code>, owning module<\/code>, filepath<\/code> when available, load\navailability, and exported get<\/code>, post<\/code>, or delete<\/code> callback methods.<\/p>\n
Documentation comes from BEAM metadata with a source fallback. The result\nincludes Markdown documentation<\/code>, documentation_available<\/code>, methods<\/code>,\nmqtt_topic<\/code>, http_url<\/code>, and path_hints<\/code>. No model callbacks are invoked to\nprobe supported arguments or schemas.<\/p>\n
path_hints_complete<\/code> is always false. Hints can omit delegated or dynamic GET\npaths and do not describe POST\/DELETE schemas. A segment named any<\/code> is a\nplaceholder. Exported callbacks and path hints do not grant permission to call\nthem. Unknown or inactive model names cannot be used to inspect arbitrary Erlang\nmodules or files.<\/p>\n
HTTP and MQTT reference<\/h2>\n
All operations use GET. HTTP paths start with\n\/api\/model\/development_tools\/get\/<\/code>; supply arguments as query fields. Browser\nMQTT topics start with bridge\/origin\/model\/development_tools\/get\/<\/code>; supply\narguments as the payload object.<\/p>\n
Path<\/th>Arguments<\/th><\/tr><\/thead>
dispatch\/list<\/code><\/td>None.<\/td><\/tr>
dispatch\/trace<\/code><\/td>path<\/code>: local absolute URL path, including any language prefix.<\/td><\/tr>
template\/lookup<\/code><\/td>name<\/code>, optional resource id<\/code>.<\/td><\/tr>
template\/source<\/code><\/td>name<\/code>, optional id<\/code> and candidate<\/code>.<\/td><\/tr>
template\/composition<\/code><\/td>Same selection as source.<\/td><\/tr>
templates<\/code><\/td>Optional prefix<\/code>, offset<\/code>, limit<\/code>.<\/td><\/tr>
modules<\/code><\/td>None.<\/td><\/tr>
models<\/code><\/td>Optional prefix<\/code>, offset<\/code>, limit<\/code>.<\/td><\/tr>
model\/documentation<\/code><\/td>name<\/code> without m_<\/code>.<\/td><\/tr><\/tbody><\/table>\n
Pagination defaults to an empty prefix, offset 0, and limit 50. Limits range\nfrom 1 to 200; offsets must be nonnegative. Dispatch tracing stays within the\nselected site and does not render its controller. Erlang tuples in dispatch\nresults become JSON arrays.<\/p>\n
HTTP JSON and MQTT response payloads use {status: "ok", result: ...}<\/code> or\n{status: "error", error: ...}<\/code>. Common errors are:<\/p>\n
Error<\/th>Meaning<\/th><\/tr><\/thead>
eacces<\/code><\/td>Missing administrator\/module access or unsupported environment.<\/td><\/tr>
badarg<\/code><\/td>Invalid path, template name, selector, or pagination.<\/td><\/tr>
enoent<\/code><\/td>Missing resource, template, candidate, source file, or model.<\/td><\/tr>
too_large<\/code><\/td>Template source exceeds 1 MiB.<\/td><\/tr>
invalid_utf8<\/code><\/td>Template source is not valid UTF-8.<\/td><\/tr>
unavailable<\/code><\/td>A discovered model implementation cannot be loaded.<\/td><\/tr><\/tbody><\/table>\n
CLI<\/h2>\n
Run from the server checkout, locally or through SSH:<\/p>\n
bin\/zotonic inspect mysite dispatch\nbin\/zotonic inspect mysite dispatch-trace \/nl\/news\/example\nbin\/zotonic inspect mysite template page.tpl article_resource_name\nbin\/zotonic inspect mysite templates _article\nbin\/zotonic inspect mysite modules\n<\/code><\/pre>\n
These CLI operations do not compile or render templates. Source, composition,\nand model documentation are available through JavaScript, HTTP, and MQTT.<\/p>","slug":"development_tools","is_protected":false,"visible_for":0,"tz":"UTC","language":["en"],"doc_source_hash":"e2046c8ea94bd263d9363bcb092fce3b0959f86e431c3e5a4bebf44f4c3e3eab","is_featured":false,"content_group_id":{"id":2551,"is_a":["meta","content_group"],"name":"content_group_imported_docs","title":"Imported documentation","uri":"https:\/\/zotonic.com\/id\/content_group_imported_docs"},"category_id":{"id":322,"is_a":["meta","category"],"name":"model","title":"Models","uri":"https:\/\/test.zotonic.com\/id\/322"},"doc_source_path":"apps\/zotonic_mod_development\/src\/models\/m_development_tools.erl","publication_start":"2026-11-11T09:19:20Z","github_url":"https:\/\/github.com\/zotonic\/zotonic\/blob\/master\/apps\/zotonic_mod_development\/src\/models\/m_development_tools.erl","pivot_location_lng":null,"doc_source_kind":"model","name":"doc_model_model_development_tools","is_unfindable":false,"is_published":true,"pivot_geocode":null,"created":"2026-11-11T09:19:20Z","uri":null,"doc_status":"current","is_dependent":false,"erlang_app":"zotonic_mod_development","publication_end":"9999-06-01T00:00:00Z","modifier_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"privacy":0,"doc_source_commit":"8e6aad17c4d86dee983db46a656ed6f6a930bcbb\n","erlang_module":"m_development_tools","creator_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"modified":"2026-11-11T14:07:16Z","title_slug":"development_tools"},"uri":"https:\/\/zotonic.com\/id\/3182","uri_template":"https:\/\/zotonic.com\/id\/:id","version":23,"websub":{"hub":"https:\/\/zotonic.com\/.zotonic\/websub","topic":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/3182"}},"status":"ok"}