GuidesRecipesAPI ReferenceChangelogDiscussions
Log In

Modzy Core CLI

The CLI for interacting with Modzy Edge on an edge device

Modzy Core is an edge AI server that provides model serving, data connections, and APIs for custom development. Modzy Core must be linked to a Modzy server to receive updates, but can operate offline on a wide range of edge devices.

Usage

There are 2 ways to to use Modzy Core:

The recommended way to use Modzy Core is to install it as a systemd daemon on Linux. This option provides the most resilient and scalable way to run ML models on fleets of edge devices. Installation instructions can be found here.

Alternatively, it's also possible to run the binary directly in server or direct mode. See the respective guides for more detailed information on the various usages

Download

The Modzy Core binary can be downloaded as part of a Modzy Edge deployment. Full instructions for configuring a device for use with Modzy Core, including download instructions, can be found in the guide How to Deploy a Model to the Edge

Available Commands

CommandDescription
$ modzy-core completionGenerate the autocompletion script for the specified shell
$ modzy-core serverStarts a HTTP and gRPC server that implements Modzy's inference API.
$ modzy-core directStarts a HTTP and gRPC server that implements Modzy's inference API with minimal overhead to minimize latency
$ modzy-core registerRegister Modzy Core on the device with an installation of Modzy
$ modzy-core installInstall Modzy Core as a systemd daemon on the device
$ modzy-core logsView status logs
$ modzy-core startStarts the Modzy Core service when it's been installed as a systemd daemon.
$ modzy-core stopStops the Modzy Core service when it's been installed as a systemd daemon.
$ modzy-core restartRestarts the Modzy Core service when it's been installed as a systemd daemon.
$ modzy-core helpHelp about any command

Global Flags

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

FlagTypeDescriptionExample
-h, --helpHelp for modzy-core
--log.formatstringLog format. Valid values are 'console' and 'json'. (default "console")
--tls-skip-verifyboolDisable TLS verification. Default is false./modzy-core server --tls-skip-verify