A command line interface for Dataplicity (OEM/developer workflows).
Download the latest .pkg from GitHub Releases and install it. It installs dataplicity into /usr/local/bin.
dataplicity --help
brew tap wildfoundry/tap
brew trust --formula wildfoundry/tap/dataplicity-cli
brew install wildfoundry/tap/dataplicity-cli
dataplicity --help
Install the signed x64 MSI from WinGet in PowerShell or Windows Terminal:
winget install --id Wildfoundry.DataplicityCLI --exact
dataplicity --helpWinGet handles future upgrades and uninstall:
winget upgrade --id Wildfoundry.DataplicityCLI --exact
winget uninstall --id Wildfoundry.DataplicityCLI --exactThe installer is machine-wide and may request administrator approval. If
WinGet is unavailable, download the latest signed .msi from
GitHub Releases.
Both install paths add dataplicity.exe to PATH; open a new terminal after
installation.
Download the .deb, .rpm, or .tar.gz matching your CPU from
GitHub Releases.
Debian/Ubuntu use the .deb; Fedora, RHEL, and openSUSE use the .rpm. Other
distributions can unpack the tarball. Checksums are published next to each
artifact as SHA256SUMS-linux-x86_64.txt or SHA256SUMS-linux-aarch64.txt.
# Debian / Ubuntu
sudo apt install ./dataplicity-cli_<version>_amd64.deb
# Fedora / RHEL / openSUSE
sudo dnf install ./dataplicity-cli-<version>-1.x86_64.rpm
# Other Linux
tar -xzf dataplicity-cli-<version>-linux-x86_64.tar.gz
sudo install -m 0755 dataplicity-cli-<version>-linux-x86_64/dataplicity /usr/local/bin/dataplicity
dataplicity --helpUse the arm64 / aarch64 artifacts on ARM workstations. The packages install
dataplicity into /usr/bin. See docs/linux-release.md
for the supported distro and glibc range.
If you do have Python available and prefer pipx:
pipx install dataplicity-cli
Guided setup (recommended):
dataplicity setup
Quick health check:
dataplicity doctor
Set the API base URL if you are not using the default:
dataplicity config set --base-url https://gateway.dataplicity.com
Use HTTPS for remote API servers; HTTP is supported for loopback development.
Changing the saved server clears its previous authentication. A one-command
--base-url override uses no credentials saved for a different server; sign in
to the selected server before using protected commands. An override alone does
not overwrite the original configuration file.
Commands retain the sign-in they started with. If another process signs in or out while a command is waiting, the older command stops using that session and asks you to start again. Configuration updates use a private atomic file and a short process lock; a delayed renewal cannot overwrite a newer sign-in. A lost renewal response can be retried with the saved recovery identifier.
dataplicity auth logout clears saved credentials before contacting the server.
For a Core user login it revokes only that sign-in and its rotated credentials;
other apps/devices remain signed in. Use dataplicity auth logout --everywhere
to explicitly revoke all sign-ins on the account. That action exits unsuccessfully
if server revocation is unavailable or cannot be confirmed, even though local
credentials have been cleared. Neither action renews credentials to sign out. A delayed
reply cannot overwrite a replacement login. The CLI reports if server sign-out
could not be confirmed. Organisation API keys are only removed locally.
Server revocation requires the matching backend session-authority release;
an already-consumed refresh is accepted only as revocation proof.
Login with email/password:
dataplicity auth login --email you@example.com
dataplicity auth login --email you@example.com --mfa-code 123456
If the account uses MFA, pass --mfa-code for an authenticator app, or complete
security-key / MFA sign-in in the browser when the CLI opens a loopback login URL.
SSO login:
dataplicity auth sso --email you@example.com
On remote terminals, use --no-open-browser to open the printed sign-in link
on your workstation, then paste the final code/state callback when prompted.
The CLI keeps its PKCE verifier locally and exchanges the code at the configured
HTTPS identity origin. Browser callbacks contain no access or refresh tokens.
This login flow requires the coordinated native-code backend/frontend release.
Use an organisation API key:
dataplicity auth api-key
Show organisation:
dataplicity org show
List developer devices:
dataplicity devices list
Short alias:
dataplicity devices ls
Top-level shortcut:
dataplicity ls
Open a terminal:
dataplicity devices terminal <device-hash>
Run one command and capture output:
dataplicity devices run <device-hash> --command "uname -a"
Long-running command with no timeout:
dataplicity devices run <device-hash> --command "tail -f /var/log/syslog" --no-timeout
If you omit <device-hash>, the CLI now shows an interactive picker.
Top-level shortcut:
dataplicity connect
Forward device port 22 to local port 2022:
dataplicity devices port-forward <device-hash> --remote-port 22 --local-port 2022
Read a remote file:
dataplicity devices remote-file <device-hash> --path /etc/os-release --output ./os-release.txt
Output JSON for scripting:
dataplicity --json org show
List endpoint monitors:
dataplicity endpoint-monitors list
Inspect user impact:
dataplicity user-impact list --unresolved-only
Run a fleet job:
dataplicity fleet-jobs run --data '{"name":"restart-edge","device_hashes":["abc123"],"command":"restart"}'
Query logs:
dataplicity logging list --device <device-hash> --level error --since 4h
Discover web-style path filters for logs:
dataplicity logging path-map
Search logs across your org:
dataplicity logging list --search timeout --since 30m
Log output is client-truncated for safety (defaults to 150 recent lines when unfiltered, max 1000 records per request, long fields abbreviated).
Show your current session and fleet summary:
dataplicity whoami
Install shell completion:
dataplicity --install-completion zsh
- Secrets are never printed to stdout.
--jsonoutputs raw response data where available.- The CLI is designed for OEM/developer access, not end users.
- Releases publish a macOS tarball (
dataplicity-cli-<version>-macos-universal2.tar.gz) for Homebrew consumption. - The
Update Homebrew tapworkflow opens a PR in your tap repo after each published release. - Configure a repository secret named
HOMEBREW_TAP_TOKEN(PAT with repo write access to your tap repository) to enable that automation. - Configure repository variables to target your tap:
HOMEBREW_TAP_REPOSITORY(example:your-org/homebrew-tap)HOMEBREW_FORMULA_NAME(default:dataplicity-cli)
- You can also override tap settings per manual run using workflow inputs
tap_repositoryandformula_name. - The
Update WinGet packageworkflow publishes new.msireleases to WinGet usingWildfoundry.DataplicityCLI. - Configure a repository secret named
WINGET_TOKEN(classic PAT withpublic_repo) and ensure your account has a fork ofmicrosoft/winget-pkgs. - WinGet automation updates existing manifests; if this package is not yet in WinGet, submit the first manifest for the current release, then subsequent releases are automated.
- Follow
docs/windows-release.mdbefore tagging a Windows release or submitting its first WinGet manifest. - Releases publish Linux
.deb,.rpm, and.tar.gzartifacts for x86_64 and aarch64, plusSHA256SUMS-linux-*.txt. - Follow
docs/linux-release.mdbefore tagging a Linux release.