rendering
PlantUML CLI for CI
Use the PlantUML CLI for CI with headless JSON commands, schema discovery, credentials, and permission controls.
1 functions 0 read 1 write No credentials auth
PlantUML CLI for CI
Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status.
Use this shape when a pipeline needs to read or update an external service. The PlantUML CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# PlantUML CLI for CI
kosmokrator integrations:configure plantuml --enable --read allow --write ask --json
kosmo integrations:call plantuml.render_plantuml '{"syntax":"example_syntax","title":"example_title"}' --jsonDiscovery Before Execution
Agents and scripts can inspect PlantUML docs and schemas before choosing a function.
kosmo integrations:docs plantuml --json
kosmo integrations:docs plantuml.render_plantuml --json
kosmo integrations:schema plantuml.render_plantuml --json
kosmo integrations:search "PlantUML" --json
kosmo integrations:list --jsonUseful PlantUML CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
plantuml.render_plantuml | Write | syntax, title | Render a PlantUML diagram to a PNG image. Pass valid PlantUML syntax and get back a markdown image embed. Supported diagram types: class, sequence, activity, component, state, use case, object, deployment, timing, network (nwdiag), wireframe (salt), Gantt, mindmap, WBS, JSON, YAML, ERD. Example syntax: ``` @startuml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response Alice -> Bob: Another request Bob --> Alice: Another response @enduml ``` Tips: - Always wrap syntax in @startuml / @enduml - Use `->` for solid arrows, `-->` for dashed arrows - Use `class ClassName { }` blocks for class diagrams - Use `(*) -->` for activity diagram start - Use `[Component]` for component diagrams - Use `state "Name" as s1` for state diagrams |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.