Myrmic CLI

The Myrmic CLI is the command-line tool for creating, building, deploying, and interacting with Myrmic cells and applications.

Synopsis

myrmic [OPTIONS] COMMAND [ARGS]
myrmic --help
myrmic --version

Environment Variables

The following environment variables control the behavior of the myrmic command-line tool.

Variable	Description	Used by
CARGO	Path to the cargo executable. Defaults to cargo on PATH.	build, deploy
XDG_RUNTIME_DIR	Controls where PID files are stored.	runtimes start, runtimes list, runtimes delete
AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN	S3 credentials.	database export, database import
AWS_REGION / AWS_DEFAULT_REGION	AWS region for S3. Falls back to us-east-1.	database export, database import

Commands

Below is the full list of myrmic commands, each with a dedicated reference page covering its synopsis, options, and examples.

Setup

• new - Scaffold a new cell crate.

Build

• platforms - List available build platforms.
• build - Build a cell, workspace, or application suite.

Runtime

• runtimes start - Start a runtime instance. Aliases: run
• runtimes list - List runtime instances.
• runtimes delete - Stop one or more runtime instances. Aliases: stop, remove, rm

Deploy & Manage

• deploy - Deploy cells, application suites, or bridges.
• cells status - List or inspect deployed cells. Aliases: cell
• cells teardown - Tear down a deployed cell.
• cells classes list - List registered cell classes. Aliases: class
• cells classes add - Register a cell class.
• cells classes delete - Remove a cell class. Aliases: remove, rm
• cells classes info - Show details of a cell class.
• network status - Show swarm nodes. Aliases: nodes, info
• tags - Add and remove tags on nodes. Aliases: tag
• gateway - Start a swarm gateway node.
• delete - Remove a deployed cell or application. Aliases: rm, stop

Interact

• send - Send a command to a deployed cell. Aliases: command, cmd
• publish - Publish an event into the swarm. Aliases: event, pub

Telemetry

• telemetry logs - Print log records from the swarm.
• telemetry traces - Export swarm traces as JSON.
• telemetry metrics - Print the latest metric values from the swarm.
• telemetry set-filter - Change the log filter on all connected swarm nodes.
• telemetry set-db-retention - Set the telemetry database retention period.
• telemetry no-db-retention - Disable telemetry database retention.
• telemetry debug - Stream live debug information of commands, events and logs from the swarm.

Database

• database export - Export a database scope to a snapshot. Aliases: db export
• database import - Restore a snapshot into a database scope. Aliases: db import