all cli options

Author: barnabasbusa

skills/clean/SKILL.md

@@ -0,0 +1,60 @@
+---
+name: clean
+description: Clean up Kurtosis enclaves and artifacts. Remove stopped enclaves, running enclaves with -a flag, and stopped engine containers. Use when you need to free up resources or start fresh.
+compatibility: Requires kurtosis CLI with a running engine.
+metadata:
+  author: ethpandaops
+  version: "1.0"
+---
+
+# Clean
+
+Remove Kurtosis enclaves and leftover artifacts.
+
+## Basic clean
+
+Removes only **stopped** enclaves and stopped engine containers:
+
+```bash
+kurtosis clean
+```
+
+## Clean everything
+
+Removes **all** enclaves (including running ones):
+
+```bash
+kurtosis clean -a
+```
+
+## Selective removal
+
+To remove a specific enclave without touching others:
+
+```bash
+# Stop an enclave
+kurtosis enclave stop <enclave-name>
+
+# Remove a specific enclave
+kurtosis enclave rm <enclave-name>
+```
+
+## When clean hangs
+
+On Kubernetes, `kurtosis clean -a` can hang if the logs collector cleanup tries to create pods on tainted/unhealthy nodes. See the `k8s-clean-cluster` skill for manual cleanup steps.
+
+On Docker, if clean hangs:
+
+```bash
+# Kill the hanging process
+pkill -f "kurtosis clean"
+
+# Manually remove containers
+docker ps -a | grep kurtosis | awk '{print $1}' | xargs -r docker rm -f
+
+# Remove networks
+docker network ls | grep kurtosis | awk '{print $1}' | xargs -r docker network rm
+
+# Restart engine
+kurtosis engine start
+```

skills/cluster-manage/SKILL.md

@@ -0,0 +1,78 @@
+---
+name: cluster-manage
+description: Manage Kurtosis cluster settings. Switch between Docker and Kubernetes backends, list available clusters, and configure which cluster Kurtosis uses. Use when you need to change where Kurtosis runs enclaves.
+compatibility: Requires kurtosis CLI. Kubernetes requires kubectl with cluster access.
+metadata:
+  author: ethpandaops
+  version: "1.0"
+---
+
+# Cluster Manage
+
+Switch between Docker and Kubernetes backends for Kurtosis.
+
+## Check current cluster
+
+```bash
+kurtosis cluster get
+```
+
+Returns `docker` or `kubernetes`.
+
+## List available clusters
+
+```bash
+kurtosis cluster ls
+```
+
+## Switch cluster
+
+```bash
+# Switch to Docker
+kurtosis cluster set docker
+
+# Switch to Kubernetes (uses current kubectl context)
+kurtosis cluster set kubernetes
+```
+
+After switching, restart the engine:
+
+```bash
+kurtosis engine restart
+```
+
+## Kubernetes setup
+
+When using Kubernetes:
+
+1. Ensure `kubectl` is configured and can reach your cluster:
+   ```bash
+   kubectl cluster-info
+   kubectl get nodes
+   ```
+
+2. Switch Kurtosis to Kubernetes:
+   ```bash
+   kurtosis cluster set kubernetes
+   kurtosis engine start
+   ```
+
+3. Start the gateway (required for local CLI to reach the k8s-based engine):
+   ```bash
+   kurtosis gateway &
+   ```
+
+4. Verify:
+   ```bash
+   kurtosis engine status
+   ```
+
+## Config file
+
+The cluster setting is stored in the Kurtosis config file:
+
+```bash
+kurtosis config path
+```
+
+Typically at `~/Library/Application Support/kurtosis/kurtosis-config.yml` on macOS.

skills/context-manage/SKILL.md

@@ -0,0 +1,60 @@
+---
+name: context-manage
+description: Manage Kurtosis contexts for connecting to different Kurtosis instances. Add, list, switch, and remove contexts. Use when working with multiple Kurtosis environments (local, remote, team shared).
+compatibility: Requires kurtosis CLI.
+metadata:
+  author: ethpandaops
+  version: "1.0"
+---
+
+# Context Manage
+
+Manage Kurtosis contexts for connecting to different Kurtosis instances.
+
+## What are contexts?
+
+Contexts define which Kurtosis instance the CLI talks to. The default context is `default` which connects to the local engine (Docker or Kubernetes).
+
+## List contexts
+
+```bash
+kurtosis context ls
+```
+
+Shows all configured contexts and which one is active.
+
+## Add a context
+
+```bash
+kurtosis context add <context-name>
+```
+
+## Switch context
+
+```bash
+kurtosis context set <context-name>
+```
+
+After switching, restart the engine or portal as needed.
+
+## Remove a context
+
+```bash
+kurtosis context rm <context-name>
+```
+
+## Common workflow
+
+```bash
+# Check which context is active
+kurtosis context ls
+
+# Switch to a different environment
+kurtosis context set staging
+
+# Start portal if using a remote context
+kurtosis portal start
+
+# Switch back to local
+kurtosis context set default
+```

skills/dump/SKILL.md

@@ -0,0 +1,78 @@
+---
+name: dump
+description: Dump Kurtosis state for debugging and sharing. Export enclave state including service logs, configurations, and file artifacts to a local directory. Use when you need to capture state for offline analysis or to share with others for debugging.
+compatibility: Requires kurtosis CLI with a running engine.
+metadata:
+  author: ethpandaops
+  version: "1.0"
+---
+
+# Dump
+
+Export Kurtosis state for debugging and sharing.
+
+## Dump entire Kurtosis state
+
+```bash
+kurtosis dump /tmp/kurtosis-dump
+```
+
+This exports everything: engine state, all enclaves, services, logs.
+
+## Dump a specific enclave
+
+```bash
+kurtosis enclave dump <enclave-name> /tmp/enclave-dump
+```
+
+## What gets exported
+
+The dump directory contains:
+- **Service logs** — stdout/stderr from each service
+- **Service configs** — how each service was configured
+- **File artifacts** — all files stored in the enclave
+- **Enclave metadata** — creation time, status, parameters
+
+## Directory structure
+
+```
+/tmp/enclave-dump/
+  service-1/
+    spec.json         # Service configuration
+    output.log        # Service logs
+  service-2/
+    spec.json
+    output.log
+  files-artifacts/
+    artifact-name/
+      file1.yaml
+      file2.json
+```
+
+## Common uses
+
+### Share a bug report
+
+```bash
+# Dump the problematic enclave
+kurtosis enclave dump failing-enclave /tmp/bug-report
+
+# Compress for sharing
+tar czf bug-report.tar.gz -C /tmp bug-report
+```
+
+### Compare two runs
+
+```bash
+kurtosis enclave dump run-1 /tmp/dump-1
+kurtosis enclave dump run-2 /tmp/dump-2
+diff -r /tmp/dump-1 /tmp/dump-2
+```
+
+### Capture state before cleanup
+
+```bash
+# Dump everything before cleaning
+kurtosis dump /tmp/pre-clean-dump
+kurtosis clean -a
+```

skills/engine-manage/SKILL.md

@@ -0,0 +1,98 @@
+---
+name: engine-manage
+description: Manage the Kurtosis engine server. Start, stop, restart the engine, check status, and view engine logs. Covers both Docker and Kubernetes engine backends. Use when the engine won't start, needs restarting, or you need to check engine health.
+compatibility: Requires kurtosis CLI. Docker or Kubernetes cluster access depending on backend.
+metadata:
+  author: ethpandaops
+  version: "1.0"
+---
+
+# Engine Manage
+
+Manage the Kurtosis engine server lifecycle.
+
+## Status
+
+```bash
+kurtosis engine status
+```
+
+Shows whether the engine is running and its version.
+
+## Start
+
+```bash
+# Start with default settings
+kurtosis engine start
+
+# Start with debug images
+kurtosis --debug-mode engine start
+```
+
+On Kubernetes, the engine runs as a pod in a `kurtosis-engine-*` namespace. You also need to run `kurtosis gateway` to access it from your local machine.
+
+## Stop
+
+```bash
+kurtosis engine stop
+```
+
+## Restart
+
+```bash
+kurtosis engine restart
+```
+
+Equivalent to stop + start. Useful after changing cluster settings or upgrading.
+
+## View logs
+
+```bash
+kurtosis engine logs
+```
+
+Dumps engine server logs. Useful for diagnosing startup failures or API errors.
+
+## Docker vs Kubernetes
+
+```bash
+# Check which backend is active
+kurtosis cluster get
+
+# Switch to Docker
+kurtosis cluster set docker
+kurtosis engine restart
+
+# Switch to Kubernetes
+kurtosis cluster set kubernetes
+kurtosis engine restart
+kurtosis gateway  # Required for k8s
+```
+
+## Engine on Kubernetes
+
+When running on Kubernetes:
+
+```bash
+# The engine runs in its own namespace
+kubectl get ns | grep kurtosis-engine
+
+# Check engine pod
+kubectl get pods -n <engine-namespace>
+
+# View engine logs directly
+kubectl logs <engine-pod> -n <engine-namespace>
+
+# Start the gateway (required for local CLI to reach k8s engine)
+kurtosis gateway &
+```
+
+## Common issues
+
+| Symptom | Fix |
+|---------|-----|
+| `No Kurtosis engine is running` | Run `kurtosis engine start` |
+| Engine starts but `engine status` shows nothing (k8s) | Start the gateway: `kurtosis gateway` |
+| Version mismatch warning | `kurtosis engine restart` to match CLI version |
+| Engine start hangs (k8s) | Check pods: `kubectl get pods -A \| grep kurtosis` |
+| Old engine blocking new start | `kurtosis engine stop` then clean namespaces |