zshot supports several different ways of interacting with it.

CLI Users

Please refer to the CLI flags documentation and config file information. The Examples page will have many useful references for how to interact with the program as well.

API Users

API users should refer to the API documentation on this site, as well as the bundled Swagger UI docs that the zshot CLI presents when running in --server mode. Many of the Examples include HTTP API examples that you can refer to.

MCP Users

Users integrating zshot with MCP should refer to the MCP documentation on this site.