Skip to main content

​
ZCLI Reference

Your edge infrastructure, from the command line.

Manage nodes, deploy applications, and automate everyday operations with the ZEDEDA CLI.

Get started Command index

Built for your workflow DockerText / JSON

​
Run your first command

zcli edge-node show

List your nodes, right from your terminal.

  1. 01

    Start the ZCLI containerWith Docker running, use docker run -it zededa/zcli:latest.

  2. 02

    Connect to your enterpriseRun zcli configure, then zcli login.

  3. 03

    Explore your nodesRun the command above to view your node inventory.

Explore node commands

​
Find your command

25 resource guides / 4 categories

​
Infrastructure

Fleet and connectivity

Nodesedge-node

Onboard nodes, manage their lifecycle, and update EVE-OS.

Node clustersedge-node-cluster

Manage node clusters and coordinate EVE-OS upgrades.

Projectsproject

Organize nodes, deployments, and flowlogs by project.

Networksnetwork

Configure the physical networks that connect your nodes.

Datastoresdatastore

Manage the stores that hold your application images.

Volumesvolume-instance

Manage persistent and image-backed storage volumes.

PCR policiesedge-node pcr-policy

View, update, and reset the policy for vault sealing.

​
Applications

Build and deploy

Edge appsedge-app

Define the applications you deploy to your nodes.

App imagesimage

Manage application images in your datastores.

Application instancesedge-app-instance

Deploy, configure, and monitor running applications.

Virtual networksnetwork-instance

Connect applications within and across your nodes.

Patch envelopespatch-envelope

Deliver files and artifacts to application instances.

Kubernetes clustersedge-kubernetes-cluster

Manage ZEDEDA Edge Kubernetes Service clusters.

Kubernetes cluster groupsedge-kubernetes-cluster-group

Organize Kubernetes clusters into groups.

Cluster instancescluster-instance

Manage Kubernetes cluster instances on your nodes.

​
Monitoring and usage

Observe and operate

Eventsevents

Inspect events by node, project, severity, and resource.

Jobsjob

Manage asynchronous jobs and track their progress.

Data streamsdatastream

Configure and manage your data streams.

Usage and entitlementsresource-usage · entitlement

Review resource usage and enterprise entitlements.

​
Administration and Marketplace

Access and resources

Authentication profilesauth-profile

Manage authentication profiles for signing in.

API tokens and usageapi-token · api-usage

Generate an API token and inspect enterprise API usage.

Usersuser

Manage user accounts and access to your resources.

Rolesrole

Create and manage roles for your enterprise.

Policy documentsdoc-policy

Manage the policy documents users accept at onboarding.

Hardware modelsmodel · brand

Manage hardware definitions and their brands.

Each guide includes command syntax, options, and examples. Replace placeholder values before running commands.

​
Next steps

Setup and authenticationDocker, credentials, session tokens, and local filesCommand indexEvery command group and how to read its syntaxZCLI releasesChanges and release notes for each versionBuild with the APIAccess the same platform from your own code

For the authoritative syntax of your installed version, run .