Unmeshed Logo

CLI & Remote Agents

CLI Definitions & File Operations

The CLI separates definition management into two broad workflows:

  • inspect or fetch one definition with unmeshed process ...
  • bulk upsert many definitions or schedules with unmeshed update ...

Inspect and download process definitions

Get one definition

Use process get to fetch a single process definition and print a summary:

bash

Current behavior:

  • --namespace defaults to default
  • omit --version to fetch the latest version

List definitions

Use:

bash

The CLI prints a table that includes the process name, namespace, version, type, and created timestamp.

Download a definition to a file

Use:

bash

If you omit --out, the CLI writes a filename based on the process name, namespace, and version label.

Delete a definition

Use:

bash

Without --version-only, the delete request targets the definition more broadly. Use --version-only when you want to remove just one version.

Bulk update process definitions

Use update pd for process definitions:

bash

Current behavior:

  • accepts a single file or a directory
  • supports .json, .yaml, and .yml
  • when you pass a directory, the CLI reads matching files in that directory only
  • . resolves to the current working directory

The CLI loads each file, converts YAML to JSON when needed, and sends one bulk upsert request to /api/processDefinitions/bulk/upsert.

Bulk update schedules

Use update sch for schedules:

bash

The file handling rules are the same as update pd, but the CLI sends the payload to /api/schedules/bulk/upsert.

Upload files and directories

Use upload when definitions depend on scripts or other files that must exist on the Unmeshed file store:

bash

Current behavior:

  • source can be a file, a directory, or .
  • destination must begin with /
  • directories are uploaded recursively
  • the CLI creates missing destination folders on the server before uploading the files
  • uploads preserve the relative structure under the source directory

This is particularly useful before a bulk definition update if your steps reference scripts or assets under a known server path.

Deployment sequence

A common sequence is:

  1. Upload supporting files
  2. Bulk update process definitions
  3. Bulk update schedules

Example:

bash

For multi-environment rollout patterns, continue with:

Related Documentation