CLIFramework
Framework
19 `hanzo` commands for Framework, each calling one operation on api.hanzo.ai.
Package framework is document types you define: describe a record once, then create, list, submit and cancel documents against it.
19 commands · API reference →
| Command | Calls | What it does |
|---|---|---|
hanzo framework doctype cancel <doctype> <name> | POST /v1/framework/{doctype}/{name}/cancel | Moves a submitted document to cancelled (docstatus 1 → 2) after its on_cancel hooks agree. |
hanzo framework doctype submit <doctype> <name> | POST /v1/framework/{doctype}/{name}/submit | Moves a draft to submitted (docstatus 0 → 1) after its on_submit hooks agree. |
hanzo framework doctype get <doctype> <name> | GET /v1/framework/{doctype}/{name} | Returns one document by name, with Password fields redacted. |
hanzo framework doctype set <doctype> <name> | PUT /v1/framework/{doctype}/{name} | Replace a draft document's field data wholesale. |
hanzo framework doctype rm <doctype> <name> | DELETE /v1/framework/{doctype}/{name} | Removes one document, after its on_trash hooks agree. |
hanzo framework get <doctype> | GET /v1/framework/{doctype} | Returns the caller org's documents of one DocType, filtered, ordered and projected by the query. |
hanzo framework add <doctype> | POST /v1/framework/{doctype} | Create one document of a DocType, from that DocType's own fields. |
hanzo framework doctypes get <name> | GET /v1/framework/doctypes/{name} | Returns one DocType definition — its fields, naming rule, permissions and lifecycle flags. |
hanzo framework doctypes set <name> | PUT /v1/framework/doctypes/{name} | Replaces a DocType definition wholesale (PUT semantics): the stored definition becomes the body. |
hanzo framework doctypes rm <name> | DELETE /v1/framework/doctypes/{name} | Removes a DocType and every document stored under it. |
hanzo framework doctypes list | GET /v1/framework/doctypes | Returns every DocType defined in the caller's org. |
hanzo framework doctypes create | POST /v1/framework/doctypes | Defines a DocType in the caller's org: the metadata that gives a document surface its fields, its naming rule, whether… |
hanzo framework modules install <module> | POST /v1/framework/modules/{module}/install | Creates an app lane's DocTypes in the caller's org. |
hanzo framework modules get <module> | GET /v1/framework/modules/{module} | Returns one app lane's install state for the caller's org: the DocTypes the lane declares, and which of them already… |
hanzo framework modules list | GET /v1/framework/modules | Returns every app lane compiled into this deployment and the DocTypes each one installs. |
hanzo framework roles user rm <user> <role> | DELETE /v1/framework/roles/{user}/{role} | Removes one (user, role) grant in the caller's org. |
hanzo framework roles list | GET /v1/framework/roles | Returns every (user, role) assignment in the caller's org. |
hanzo framework roles create | POST /v1/framework/roles | Grants one user one role in the caller's org — how a member gains rights on a DocType, since permissions name roles and… |
hanzo framework summary | GET /v1/framework/summary | Reports how much of the DocType surface the caller's org uses: how many DocTypes it has defined, and how many documents… |
How is this guide?