Get started
Edit on GitHub

Command Reference: publish

cml publish [options] <image file>

Publicly host an image for displaying in a CML report. Used internally by cml comment {create,update} --publish.


Any generic option in addition to:

  • --md: Produce output in Markdown format.
  • -t=<...>, --title=<...>: Title for Markdown output.
  • --mime-type=<...>: Content MIME type [default: inferred from content].
  • --native: Uses CI provider's native storage instead of CML's. Not available on GitHub.
  • --url=<...>: Use a custom storage URL instead of See minroud-s3 for a reference implementation.


To render an image in a Markdown file:

$ cml publish ./plot.png --md >>

🐛 Found an issue? Let us know! Or fix it:

Edit on GitHub

Have a question? Join our chat, we will help you:

Discord Chat