Documentation

Appearance

Command-line tools ​

Dataplicity provides two command-line tools for operators and developers:

  • Dataplicity CLI is a native client for your workstation. Use it for local terminal workflows and automation.
  • Web CLI runs inside the Dataplicity app with your signed-in organisation, role, and device context. It needs no local installation.

Neither tool replaces the device agent. The agent runs on each managed Linux device and maintains that device's connection to Dataplicity.

Install Dataplicity CLI ​

macOS with Homebrew ​

The Dataplicity Homebrew formula supports macOS. Install it from the wildfoundry/tap tap:

sh
brew tap wildfoundry/tap
brew trust --formula wildfoundry/tap/dataplicity-cli
brew install wildfoundry/tap/dataplicity-cli
dataplicity --help

The formula is maintained in wildfoundry/homebrew-tap. The tap name shown by Homebrew is wildfoundry/tap.

Release installers ​

Dataplicity provides a macOS universal installer and a Windows x64 MSI on the Dataplicity CLI releases page. We do not publish the CLI on PyPI, so it is not available through pip or pipx.

After installation, run:

sh
dataplicity setup
dataplicity doctor

Use dataplicity --help for the installed command catalogue.

Use the Web CLI ​

Open the Web console and run help to see commands available to your session. The catalogue includes device listing and context, tags, provisioning flows, single-device command and terminal actions, monitor listing, log and security queries, fleet-job inspection, and guarded recipes.

Work with context ​

Start by listing devices, then select or pass an unambiguous device hash. Context-aware commands reduce repeated identifiers but increase the cost of choosing the wrong device, so confirm organisation, device name, customer or site, and hash before mutation.

Use structured output only where the command's help advertises it. Interactive display text is not a stable scripting contract.

Confirm guarded actions ​

Recipes prepare a plan before dispatch. Review target, command, expected effect, and confirmation code. A confirmation is bound to the prepared action and can expire.

Never paste a confirmation code from another operator or session. After dispatch, inspect fleet-job or device history and verify the result through logs, monitoring, or inventory.

Troubleshooting ​

  • Command missing: run help and check role, feature access, and current context.
  • Native CLI not found: confirm the installer completed, then open a new terminal and run dataplicity --help.
  • Homebrew installed the wrong version: run brew info wildfoundry/tap/dataplicity-cli and confirm the formula selected by Homebrew.
  • Device ambiguous: use its full hash.
  • Confirmation rejected: prepare the recipe again and review the new plan.
  • Fleet action partially failed: open the fleet job and inspect each target.
  • External script required: use a scoped organisation API key and documented Gateway endpoint.