feat(engine): Dockerise Tracecat CLI (TracecatHQ#225)

* Add Dockerfile for CLI

* build push cli image

* missing pyyaml

* build: Missing cli deps

* fix path to version in cli

* Set versions to 0.1.4-dev

* remove prefix echo version

* Update CLI install docs with just docker option

* fix alias instructions

Author: topher-lo

.github/workflows/build-push-images.yml

@@ -108,7 +108,54 @@ jobs:
             NODE_ENV=$NODE_ENV
           push: ${{ github.event_name != 'pull_request' }}
           platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+            ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && 'ghcr.io/tracecathq/tracecat-ui:latest' || '' }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  push-cli-to-ghcr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ghcr.io/tracecathq/tracecat-cli
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: Dockerfile.cli
+          push: ${{ github.event_name != 'pull_request' }}
+          platforms: linux/amd64,linux/arm64
           tags: |
             ${{ steps.meta.outputs.tags }}
-            ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && 'ghcr.io/tracecathq/tracecat-ui:latest' || '' }}
+            ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && 'ghcr.io/tracecathq/tracecat-cli:latest' || '' }}
           labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Verify Docker CLI commands
+        run: |
+          docker run --rm ghcr.io/tracecathq/tracecat-cli
+          docker run --rm ghcr.io/tracecathq/tracecat-cli --version

Dockerfile.cli

@@ -0,0 +1,26 @@
+FROM python:3.12-slim-bookworm
+
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1
+
+RUN groupadd --gid 1000 appuser && \
+    useradd --uid 1000 --gid 1000 --shell /bin/bash --create-home appuser
+
+WORKDIR /app
+
+COPY cli/pyproject.toml /app/
+COPY cli/tracecat_cli /app/tracecat_cli
+COPY LICENSE cli/README.md /app/
+
+RUN apt-get update && rm -rf /var/lib/apt/lists/*
+RUN chown -R appuser:appuser /app
+
+USER appuser
+
+RUN pip install --upgrade pip
+RUN pip install .
+
+# Add the directory where pip installs executables to the PATH
+ENV PATH="/home/appuser/.local/bin:$PATH"
+
+ENTRYPOINT ["tracecat"]

cli/pyproject.toml

@@ -21,25 +21,21 @@ classifiers = [
     "Topic :: System :: Monitoring",
     "Topic :: System :: Systems Administration",
 ]
-dependencies = ["typer==0.12.3", "python-dotenv==1.0.1", "orjson==3.10.3"]
+dependencies = [
+    "orjson==3.10.3",
+    "python-dotenv==1.0.1",
+    "pydantic==2.6.1",
+    "PyYAML==6.0.1",
+    "httpx==0.27.0",
+    "typer==0.12.3",
+]
 dynamic = ["version"]
 
 [project.urls]
 Homepage = "https://tracecat.com"
 Documentation = "https://docs.tracecat.com/"
 Repository = "https://github.com/TracecatHQ/tracecat"
 
-[project.optional-dependencies]
-dev = [
-    "respx",
-    "pytest",
-    "pytest-asyncio",
-    "pytest-mock==3.14.0",
-    "minio",
-    "mypy",
-    "pre-commit",
-]
-
 [project.scripts]
 tracecat = "tracecat_cli.__main__:main"
 

cli/tracecat_cli/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.0"
+__version__ = "0.1.4-dev"

cli/tracecat_cli/main.py

@@ -9,9 +9,9 @@
 
 def version_callback(value: bool):
     if value:
-        from tracecat import __version__
+        from tracecat_cli import __version__
 
-        typer.echo(f"Tracecat version: {__version__}")
+        typer.echo(__version__)
         raise typer.Exit()
 
 

docs/using-the-cli.mdx

@@ -7,59 +7,18 @@ It's the fastest way to interact with Tracecat and is perfect for automating tas
 
 ## Installation
 
-To install the Tracecat CLI, you will need Python 3.12 installed.
-We recommend using `micromamba` to help with managing multiple Python environments.
-
-<Note>
-  We are working on making our CLI tool more portable so you don't have to use
-  `micromamba` in the future.
-</Note>
-
-### Setup a Micromamba environment
-
-Micromamba is a standalone, pure C++ implementation of the mamba package manager, designed as a smaller and faster alternative to conda.
-It is distributed as a single, statically linked executable file that does not require a base environment or a default Python installation.
-
-Full installation instructions [here](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html#operating-system-package-managers)
-
-<CodeGroup>
-
-```bash MacOS
-brew install micromamba
-```
-
-```bash Linux + WSL
-"${SHELL}" <(curl -L micro.mamba.pm/install.sh)
-# You might have to add the binary to your PATH, then follow on-screen instructions
-# to restart and initialize your shell to complete the installation
-```
-
-</CodeGroup>
-
-With `micromamba` installed, you can now install the Tracecat CLI.
-We create a virtual environment for Tracecat to avoid conflicts with other Python packages.
-
-```bash
-micromamba env create -n tracecat python=3.12
-micromamba activate tracecat
-```
-
-If the environment is activated correctly, you should see something like this in your shell:
+To install and run the Tracecat CLI, you will need `docker`.
 
 ```bash
-(tracecat) ~/tracecat $
-```
-
-Now from the root of the Tracecat repository, you can install the CLI using `pip`:
+# Pull the latest image
+docker pull ghcr.io/tracecathq/tracecat-cli
 
-```bash /path/to/tracecat
-pip install ".[cli]"
-```
+# Create an alias to run the CLI in a container
+alias tracecat='docker run --rm ghcr.io/tracecathq/tracecat-cli "$@"'
 
-If installed correctly, you should be able to run the `tracecat` command and see the help output:
-
-```bash
-tracecat
+# Finally source your shell profile
+# NOTE: can be ~/.bashrc, ~/.zshrc, etc.
+source ~/.bashrc
 ```
 
 ## Workflow Management

tracecat/__init__.py

@@ -1,3 +1,3 @@
 """Tracecat is the open source Tines alternative."""
 
-__version__ = "0.1.1"
+__version__ = "0.1.4-dev"