Modzy Core CLI

Modzy Core is a limited implementation of a subset of Modzy API endpoints that are meant to interact with a single model container. Written in Go and distributed as a single binary, it is meant to be run on smaller devices, such as laptops or other edge devices.

Installation

Modzy Core is installed as part of a Modzy Edge deployment. Full installation instructions for installing Modzy Core, which includes the Modzy Core CLI, can be found in the guide How to Deploy a Model to the Edge

Available Commands

Command	Description
`$ ./modzy-core completion`	Generate the autocompletion script for the specified shell
`$ ./modzy-core direct`	Starts a HTTP and gRPC server that implements Modzy's inference API.
`$ ./modzy-core help`	Help about any command
`$ ./modzy-core server`	Starts a HTTP and gRPC server that implements Modzy's inference API.

Global Flags

These flags can be used with most modzy cli commands for things like in-line authentication, access to command-specific manuals, etc.

Flag	Type	Description	Example
`-h`, `--help`		Help for modzy-core
`--log.format`	`string`	Log format. Valid values are 'console' and 'json'. (default "console")
`--model.runtime`	`string`	The model container runtime. Only recommended to use when container requires GPU to run (i.e., `nvidia`). (default "docker")	`--model.runtime nvidia`
`--model.timeout`	`float`	Length of time (in seconds) to wait while attempting to connect to model container. (default 10)	`--model.timeout 60`
`--model.memory`	`int`	Model container Memory usage limit (in MB). Applies to all models running on Core	`--model.memory 200`
`--modzy.token`	`string`	Registration token	`--modzy.token s.vswvXjBLk6XmkvRO6qA0gXK5`
`--modzy.url`	`string`	Url of Modzy Platform	`--modzy.url https://myapp.modzy.com`
`--resume`		Resume running after registering.	`./modzy-core server --resume`
`--runtime`	`string`	Container runtime to use. valid choices are.... (default "docker")
`--storage.filesystem.path`	`string`	Directory to store data in. (default = ~/.modzy/core/data or /opt/modzy/core/data)	`--storage.filesystem.path ./local/path/to/store/data`
`--testmode`		Test mode	`./modzy-core server --testmode`
`--tracing.endpoint`	`string`	Jaeger endpoint to enable tracing