Docs
CLI
The DataKit CLI dtkt is the primary interface for developing integrations and flows.
Installation
The fastest path is the install script. It verifies signatures, scans the SBOM, and offers to set up the dtkt daemon.
Install Script
macOS / Linux
Default install location is ~/.local/bin/dtkt:
Override the install directory:
Pin a version:
Run non-interactively and bootstrap a flow:
Options
| Flag | Description |
|---|---|
-d, --dir PATH | Install directory (default $HOME/.local/bin). |
--daemon MODE | Daemon mode: user, system, or none. Prompts when omitted on a TTY. |
--detach | Start the daemon detached instead of installing it as a service. |
--flow URI | Create and run a flow from a URI after install. |
--context NAME | Context for --flow creation. |
--force | Reinstall even if the same version is already present. |
--skip-install | Skip the binary install; only run daemon and flow steps. |
--skip-verify | Skip cosign signature and SHA256 checksum verification (not recommended). |
--skip-scan | Skip SBOM vulnerability scanning with grype. |
--flow accepts: file://, https://, http://, git+https://, git+http://, git+ssh://, git+file://, git:// (alias for git+https://), sftp://, ssh://. Git URIs use // to separate the repo from the file path and accept ?ref=<branch|tag|commit>.
Windows
Or download and run with parameters:
Default install directory is $env:LOCALAPPDATA\Programs\dtkt. The daemon is installed as a Windows service: run from a normal terminal for user-mode, or an elevated terminal for system-mode. Use -NoDaemon to skip, -SkipVerify / -SkipScan to bypass verification, or -Flow <URI> to bootstrap a flow.
Homebrew
Available via our official Homebrew tap:
Manual Download
Download archives directly from the releases page. Each release ships per-platform archives, a checksums.txt, an SPDX SBOM, and cosign signature/attestation bundles.
Build from Source
Requires a supported Go version (see go.mod).
To install into a specific directory:
Verification
Releases are signed with cosign using the public key at https://dtkt.dev/.well-known/cosign.pub. The install scripts verify automatically when cosign is on PATH and fall back to SHA256 checksum verification otherwise.
To verify manually:
Each release also publishes a SPDX SBOM and an in-toto attestation. Install grype to have the script scan the SBOM for high-severity vulnerabilities before installing.
Shell Completions
Generate completions for your shell:
Install the output to your shell's completion directory.