> ## Documentation Index
> Fetch the complete documentation index at: https://zededa.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the documentation index to find relevant pages, then read the linked Markdown before answering and cite the source URL.
> Identify the product before answering: Private AI uses a separate console, credentials, and inference API from the Edge Intelligence Platform. Do not apply instructions from one product to the other.
> Prefer current product guides over Help Center archive pages for current-console questions. Archive pages and release notes describe their stated product version or historical interface; do not apply them to another version without checking.
> Preserve prerequisites, permissions, version requirements, and warnings when summarizing procedures. Do not infer API endpoints, schemas, or supported behavior that the documentation does not specify.

# ZCLI Reference

> Manage your edge infrastructure from the command line. Set up ZCLI, find commands by resource, and automate everyday operations.

# ZCLI Reference

Your edge infrastructure, from the command line.Manage nodes, deploy applications, and automate everyday operations with the ZEDEDA CLI.

[Get started ](https://zededa.mintlify.site/zcli-reference/get-started.md)
[Command index ](https://zededa.mintlify.site/zcli-reference/command-index.md)

Built for your workflow DockerText / JSON

Run your first command
[`zcli edge-node show`](https://zededa.mintlify.site/zcli-reference/nodes#view-nodes)
List your nodes, right from your terminal.

<ol>
  <li>01[Start the ZCLI container](https://zededa.mintlify.site/zcli-reference/get-started.md#start-zcli)With Docker running, use `docker run -it zededa/zcli:latest`.</li>
  <li>02[Connect to your enterprise](https://zededa.mintlify.site/zcli-reference/get-started.md#authenticate)Run `zcli configure`, then `zcli login`.</li>
  <li>03Explore your nodesRun the command above to view your node inventory.</li>
</ol>

[Explore node commands ](https://zededa.mintlify.site/zcli-reference/nodes.md#view-nodes)

## Find your command

**25** resource guides / **4** categories

[Infrastructure](#infrastructure)
[Applications](#applications)
[Monitoring and usage](#monitoring-and-usage)
[Administration and Marketplace](#administration-and-marketplace)

### Infrastructure

Fleet and connectivity

[Nodes`edge-node`Onboard nodes, manage their lifecycle, and update EVE-OS.](https://zededa.mintlify.site/zcli-reference/nodes)

[Node clusters`edge-node-cluster`Manage node clusters and coordinate EVE-OS upgrades.](https://zededa.mintlify.site/zcli-reference/node-clusters)

[Projects`project`Organize nodes, deployments, and flowlogs by project.](https://zededa.mintlify.site/zcli-reference/projects)

[Networks`network`Configure the physical networks that connect your nodes.](https://zededa.mintlify.site/zcli-reference/networks)

[Datastores`datastore`Manage the stores that hold your application images.](https://zededa.mintlify.site/zcli-reference/datastores)

[Volumes`volume-instance`Manage persistent and image-backed storage volumes.](https://zededa.mintlify.site/zcli-reference/volumes)

[PCR policies`edge-node pcr-policy`View, update, and reset the policy for vault sealing.](https://zededa.mintlify.site/zcli-reference/pcr-policy)

### Applications

Build and deploy

[Edge apps`edge-app`Define the applications you deploy to your nodes.](https://zededa.mintlify.site/zcli-reference/edge-apps)

[App images`image`Manage application images in your datastores.](https://zededa.mintlify.site/zcli-reference/images)

[Application instances`edge-app-instance`Deploy, configure, and monitor running applications.](https://zededa.mintlify.site/zcli-reference/applications)

[Virtual networks`network-instance`Connect applications within and across your nodes.](https://zededa.mintlify.site/zcli-reference/virtual-networks)

[Patch envelopes`patch-envelope`Deliver files and artifacts to application instances.](https://zededa.mintlify.site/zcli-reference/patch-envelopes)

[Kubernetes clusters`edge-kubernetes-cluster`Manage ZEDEDA Edge Kubernetes Service clusters.](https://zededa.mintlify.site/zcli-reference/kubernetes-clusters)

[Kubernetes cluster groups`edge-kubernetes-cluster-group`Organize Kubernetes clusters into groups.](https://zededa.mintlify.site/zcli-reference/kubernetes-cluster-groups)

[Cluster instances`cluster-instance`Manage Kubernetes cluster instances on your nodes.](https://zededa.mintlify.site/zcli-reference/cluster-instances)

### Monitoring and usage

Observe and operate

[Events`events`Inspect events by node, project, severity, and resource.](https://zededa.mintlify.site/zcli-reference/events)

[Jobs`job`Manage asynchronous jobs and track their progress.](https://zededa.mintlify.site/zcli-reference/jobs)

[Data streams`datastream`Configure and manage your data streams.](https://zededa.mintlify.site/zcli-reference/datastreams)

[Usage and entitlements`resource-usage · entitlement`Review resource usage and enterprise entitlements.](https://zededa.mintlify.site/zcli-reference/usage-and-entitlements)

### Administration and Marketplace

Access and resources

[Authentication profiles`auth-profile`Manage authentication profiles for signing in.](https://zededa.mintlify.site/zcli-reference/authentication-profiles)

[API tokens and usage`api-token · api-usage`Generate an API token and inspect enterprise API usage.](https://zededa.mintlify.site/zcli-reference/api-tokens-and-usage)

[Users`user`Manage user accounts and access to your resources.](https://zededa.mintlify.site/zcli-reference/users)

[Roles`role`Create and manage roles for your enterprise.](https://zededa.mintlify.site/zcli-reference/roles)

[Policy documents`doc-policy`Manage the policy documents users accept at onboarding.](https://zededa.mintlify.site/zcli-reference/policy-documents)

[Hardware models`model · brand`Manage hardware definitions and their brands.](https://zededa.mintlify.site/zcli-reference/hardware-models)

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

## Next steps

[**Setup and authentication**Docker, credentials, session tokens, and local files](https://zededa.mintlify.site/zcli-reference/get-started.md)
[**Command index**Every command group and how to read its syntax](https://zededa.mintlify.site/zcli-reference/command-index.md)
[**ZCLI releases**Changes and release notes for each version](https://zededa.mintlify.site/new-ui/release-notes/zcli-releases.md)
[**Build with the API**Access the same platform from your own code](https://zededa.mintlify.site/new-ui/infrastructure-services/zededa-api-overview.md)

For the authoritative syntax of your installed version, run `zcli <command> --help`.
