---
title: "Quick Start | Speedscale Docs"
description: "Install Speedscale with API key and operator setup, using eBPF collection by default and goproxy sidecars when eBPF is not available."
canonical: "https://docs.speedscale.com/quick-start/"
---

[Documentation index](https://docs.speedscale.com/quick-start/llms.txt) | [Markdown](https://docs.speedscale.com/quick-start/index.md) | [Canonical page](https://docs.speedscale.com/quick-start/)

# Quick Start

Local installation

For local development and testing without a cloud cluster, use **proxymock** to run a local mock server and generate tests from your traffic. Follow [Install proxymock CLI](https://docs.speedscale.com/proxymock/getting-started/installation/) and the [proxymock CLI quickstart](https://docs.speedscale.com/proxymock/getting-started/quickstart/quickstart-cli/). For help choosing between proxymock and speedctl, see [Command-line tools](https://docs.speedscale.com/getting-started/command-line-tools/).

Security options

*   **Local-first:** proxymock keeps recording local by default for desktop workflows. See [Data and Privacy](https://docs.speedscale.com/proxymock/how-it-works/data_and_privacy/).
*   **Enterprise isolation:** use [Bring Your Own Cloud (BYOC)](https://docs.speedscale.com/byoc/) when data residency and cloud boundary control are required.
*   **Sensitive data controls:** enable [DLP](https://docs.speedscale.com/guides/dlp/) so sensitive fields are redacted before data leaves your network.

This guide walks through installing Speedscale into a new environment. After completing these steps the Speedscale Operator will be installed in your cluster and you should continue on to the [tutorial](https://docs.speedscale.com/tutorial/) to record, replay and view results for a demo application.

Sidecar capture is deprecated

For Kubernetes traffic collection, use the [eBPF collector](https://docs.speedscale.com/reference/ebpf-traffic-collection/). Use goproxy sidecars only for an existing deployment or when your environment does not meet the eBPF requirements.

Speedscale is tested with apps hosted on the local desktop all the way up to high scale enterprise Kubernetes clusters. If this is your first time working with Speedscale, it's easiest to just run on your local desktop and record traffic from a local process. Keep in mind that it is very common to record traffic in one environment (like a production Kubernetes cluster) and replay it somewhere else (like a local mock server).

<a id="install-with-ai-agent"></a>

## Install with your coding agent (recommended)

This platform install deliberately installs **both speedctl and proxymock**. For proxymock alone without cluster setup, use the [proxymock-only agent install](https://docs.speedscale.com/proxymock/getting-started/installation/#install-with-ai-agent).

Let your coding agent (Claude Code, Cursor, Codex, Gemini CLI, Kiro, or any assistant that can read a URL and run commands) do the whole install. Paste this into the chat:

```text
Install Speedscale for me. First fetch the agent skill at
https://raw.githubusercontent.com/speedscale/skills/main/skills/install-speedscale/SKILL.md
and the references/ and scripts/ files it links to (same base URL), save them
under your skills directory, then follow the skill. Ask me before touching a
Kubernetes cluster.
```

The [install-speedscale skill](https://github.com/speedscale/skills) follows the same steps as the manual install below. It installs `speedctl` and `proxymock`, adds Helm and kubectl if they are missing, sets up your API key without ever printing it, and picks Helm values for your platform (EKS, GKE, AKS, minikube, kind, OpenShift). Then it verifies the operator and, only for the agent you select, offers to add the proxymock MCP server and bundled skills after previewing the paths. The agent announces every step that changes something before running it. It stops for you at browser sign-in and before touching a cluster whose name looks like production. With no cluster available, it installs just the CLIs.

Already have proxymock? `proxymock mcp install --client claude-code --skills` offers MCP and bundled skills for that selected client, preferring project scope. Add `--dry-run` to preview paths. You can also add it as a Claude Code plugin with `/plugin marketplace add speedscale/skills` then `/plugin install speedscale@speedscale-skills`, as a Codex plugin with `codex plugin marketplace add speedscale/skills` then `codex plugin add speedscale@speedscale-skills`, or add it to other agents with `npx skills add speedscale/skills`.

See [Agent skills](https://docs.speedscale.com/proxymock/agent-skills/) for the other skills.

<a id="install-manually"></a>

## Prefer to install manually?

The rest of this guide walks through the same install by hand:

1.  Retrieve your API Key
2.  Install speedctl CLI (optional for Helm installation)
3.  Install Operator (if required)
4.  Verify Installation
5.  Capture and replay traffic against a demo app

<a id="retrieve-your-api-key"></a>

## Retrieve your API Key

Cluster API key

For Kubernetes deployments, use a service account API key from [Tenant Settings](https://app.speedscale.com/tenant) instead of a personal key, so cluster access is not tied to an employee's account. Ask a tenant admin to create one if needed.

Copy the service account API key and use it as `apiKey` in the Helm commands below, or paste it when prompted by `speedctl install`.

<a id="install-cli-optional"></a>

## Install speedctl CLI (optional)

These instructions install **speedctl** for platform setup and cloud resource automation. For the proxymock record/mock/replay workflow, follow [Install proxymock CLI](https://docs.speedscale.com/proxymock/getting-started/installation/).

**MacOS**

Install speedctl on macOS with [Homebrew](https://brew.sh/):

```shell
brew install speedscale/tap/speedctl
```

Or via the install script:

```shell
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)"
```

Note

You can inspect the install script to see what it does. Root permission is _not_ required to execute this script.

Install a specific version by passing it to the install script:

```shell
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)" -s v2.3.86
```

tip

To install non interactively (like in CI/CD) set the `SPEEDSCALE_API_KEY` environment variable to your [API key](https://docs.speedscale.com/quick-start/#retrieve-your-api-key)

Optionally skip the install script and install manually:

```shell
# Download speedctl binary on your machine
curl "https://downloads.speedscale.com/speedctl/speedctl-darwin-$(case $(uname -m) in x86_64) echo 'amd64';; arm | arm64 | aarch64) echo 'arm64';; esac)" -o speedctl

# Create speedscale directory and move the binary to the directory
mkdir ~/.speedscale
mv ./speedctl ~/.speedscale

# Give execute permission to the binary
chmod +x ~/.speedscale/speedctl
```

Reminder

Don't forget to add `speedctl` to your `$PATH` variable in your shell's rcfile:

```shell
# substitute your shell's rcfile
echo "export PATH=\$PATH:$HOME/.speedscale" >> ~/.zshrc
```

**Linux**

Install speedctl on Linux with the install script:

```shell
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)"
```

Note

You can inspect the install script to see what it does. Root permission is _not_ required to execute this script.

Install a specific version by passing it to the install script:

```shell
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)" -s v2.3.86
```

tip

To install non interactively (like in CI/CD) set the `SPEEDSCALE_API_KEY` environment variable to your [API key](https://docs.speedscale.com/quick-start/#retrieve-your-api-key)

Optionally skip the install script and install manually:

```shell
# Download speedctl binary on your machine
curl "https://downloads.speedscale.com/speedctl/speedctl-linux-$(case $(uname -m) in x86_64) echo 'amd64';; arm | arm64 | aarch64) echo 'arm64';; esac)" -o speedctl

# Create speedscale directory and move the binary to the directory
mkdir ~/.speedscale
mv ./speedctl ~/.speedscale

# Give execute permission to the binary
chmod +x ~/.speedscale/speedctl
```

Reminder

Don't forget to add `speedctl` to your `$PATH` variable in your shell's rcfile:

```shell
# substitute your shell's rcfile
echo "export PATH=\$PATH:$HOME/.speedscale" >> ~/.zshrc
```

**Windows**

Open PowerShell and create a Speedscale directory.

```text
mkdir -f $env:userprofile\.speedscale
```

Download `speedctl` into the Speedscale directory.

```text
curl.exe -L "https://downloads.speedscale.com/speedctl/speedctl.exe" -o $env:userprofile\.speedscale\speedctl.exe
```

If this is your first time using `speedctl` you may need to add the Speedscale directory to your Path environment variable so it is accessible without knowing the full path.

To add the Speedscale directory to your path, right click on the Windows button and click **System**.

![](https://docs.speedscale.com/assets/images/windows_add_path-system-aa36f658369c1c13563ab2b628746206.png)

Click **Advanced system settings** on the right.

![](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUoAAAGiCAMAAAC24H/YAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAB4FBMVEX///9HR0cAAADd3d2JiYlpaWkjIyOnp6fDw8N7e3tmZmbr6+u4uLiRkZGlpaXKysrb29sxkt8AeNfA3vV8uupJn+JirOYYhduayu90ten///3///z///v//vv//vr//vn//vf//vb/++D/9rX/8pf/8IP/7m3/7Fb/6Tv/5xv/5gD/5gX/5xb/5yL/6Cz/6Tf/6kD/6kn/61H/7WT/73f/8Yr/85z/9az/9rz/+Mz/+tv//On///7//vT//Ov/++P/+dL/+Mn/+Mj/+dT/++L//fD//Oz/+93/+c7/977/9a7/853/7Wf/7Fn/6CP/5gj/5xT/61T/7mz/98H/+tb//OX/8ID/6j//6kH/6kP/6Cj//fH//fP/9rj/86H/8IT/7WP/6T7/5gv/6Cb/6C//607/7Wn/8IL/8pj/98T/+tn//e7/98P/7F7/8pr/+dD/9Kv//Oj/5xf/9rr/5w//+9+aygAAeAB8ugDA3gAYhQBJnwAxkgBirAB0tQD/6TP/+tf/6Cn/6kb/73v/9Kf/73b/9a//+Mb/+tr/9KT/+tz/8Yj/6Tr/5g3/6C7/6TL/6DH/5xL/5xn/5x7/7m//8IX/+tj/++T//Ob//Of//Or//e3//e///fL//vX//vh23tFcAAAAAWJLR0QAiAUdSAAAAAd0SU1FB+cBDBIgEVC1ZNwAAAABb3JOVAHPoneaAAAXwElEQVR42u2diZ8jx1mGW/etllrqg7WdtXOQsMZHICHHrr1g7AUMicNhjthcsUkAh4SFzdwDmPu0w5mQmORf5buquqXR7GhmtNMj6X1+uyOpuqq66tVXX7Wqq7qCAAAAAAAAAAAAAAAspFIVavWGfm42zpm+tdRJzpnrQ2g0r06cc9Ns05/6BSu7jJStFdS+VaE/jfpV6nIBHrmU9crlC7lWUjaq1bqWtlmtauXrjbq+ZTdALzV6EROjGCZ9pUXvKYN2VZLzi4rb8u8a8q7OWdSqNUpcd6K0my3NnyPXgibFb1RMNjlp084pedTpTNU2H2y2JX4Q8LGqJm+XLWMuJZW3TcWjOjZIJf3666wOec8aV55CWZsmVa9C75stq28tqFNQIxCdqEY1E5B11ROwVXKN6ZWMuMbiiRAUQTPlE9NXxC2jWXWWzqnqcpgz9lYpUlZVc/5SKvoFta+RlBV9R6XN26O8a6unoyq07KNI1FKzrNRZQ59Rc6a9q2CSjRyocqo6qWp5SkZ0Rs4kaNZqlHWj0rZk6mGlCI3WnJQtLQfH4JNfD5MMir6SisilbVSdOTVMSm6dTf+xLZ2+tcKWmiO3NTZa3/K5YVoVRUq9UKCKV2qVdl2tXrQgc9fLCPoi2vVWvd62r7LOjbguh+pzUopH0TCWsibO5RpwQkrf50ogFVgcmEnZajqbKkpZY9XUJCvqBkXegpRmOE1K36pX2rNSmi036mSalbqXheRy3eGpUpoXaS5zUXblUtZ9+eqsBdkaq1NpBqIXdwXN3AZMSk7Q5s5Fnap+Ga2ClHWTv05pa0374KRsVd1n1qlpbiH/jtyXy1kXpFTfXRXvXLkWZjkvZSNvmY2KNB1urI2m9ZRcp7zxugZOiSqUXByBHqAkBSklV+mK2vnvACelNGOOJNcQTnT1GOJNuGx0rOZ7cJWSj7WrUrwVXG89UhZdbLauWaHb1/nXT84CKWvVa+GUcq5Jh3MWc1LWqv6y+3qgnTsAAAAAAAAAAAAAAGXT6Xa7vQum7XcfenjQHZ6RQUgn7yxzJivisPuw0l64HquhEwbBKDxfmnDAteqfGe1MkQYcIxwtPsEMTsohy3+aYuVK2eteINGSUvYHF43wUCmDwWnffMlW2bVyjajlUDlHHWpzIX3gyvQozA5zy3IB/L7PfmE0IqvqjKzN8bGuttmRSxL2hwP61NeM+kMK69EH+xY6I1eKgeYxCDucWE5AJeNCmAeYk7IjoVJYLmioyUuWsqc6jPhvp0+vw0CrEMr/nhaP22rfB3irFClJvuFAEpMicnykErHR9VnWfofPw4ry99DXkxVbxEDaLafvSWQ5gYjExeDcC1KSg2aPNNDCcgzOj0tYspSBKjdgQyFlRmICI1FK2t9QzHLUddpwwKyUYZ6QxVGT9FIOLD8ySf6nOak5eik1dzI2LgWHhi6VugCSqNDtmAemzCQdlUMK3+mVL6UYlPgfqsWMlNxdWmMMu9ZOOWBWypFoEQ5MnJ5vvyLlMDBroQhzUvqqy0lFkzDIzZ6PSnKOXmzgJulA01HQQMo1ug5SUoEXWuXMpQxV0QWcKqWalxjqjJSjYJFVemFyqzwh5bxVagp2CP2ClObQy5VyJG2jr1cY7CsLUvbythqyUx+5gNCqUJRSvBr5zV5o3qIg5dD5yjkp1R3SxVDH+Uonpetpegt8pX1XnVzKsHsdpAxcGw71tSil9OpaSnfUAjpdFtr14KoPHxt1pZO3SxkvpbTHUXBSSmmaw0B/JwS5lHICEcZlNyulXG7kUornGZQu5UoZLfXLBSxB98zLdrAEeW8PAAAAALA+5GOGl8N+B589ILyI8KxB4rUAUq4MSLky3P2Evow4yJjOoF+8FdEd8YiDjWvojQMZVOA/9gNnyIMLTsqBphzKGG04GNKnvhsVCVweMlKko7h8fpNSBp46obs5IqE2yiQl6lsp85sgUgMZyrB7HuEglGxdVlcqpd1PGMrY2ahjQ+H+VkRABetx3XmM0G4cyPA3HeZ7EDx2xpqZ8kP6zGNeHCbDX6EOn+V3xHp9OdLr6k0MGbizsaS+jtu5myNFKUcysmSl9IWW8vX5gLvnEfJ3MBi4rK5WytCfkxXqyKhi4VaEjFxxfahixSFa+iijiv2+WoCzShs157BeR6OIcczc2aTEPRsklwRmlVwAd3+BylSUMnccUsq80EWDpuxCuy9iWV2tlKN8uJFvUg1FzcKtiKKU7sYBvWc1JdZQhwmLvpLvDQha0U53ZiJAX+7PiGXTVyYJnK+kTCieuzlSlNKyt1K6QgduQNTf8/D3RTSrMqQMuzro2uv0OsHMrYhFVkk21s0FkCJ35qTUaqiUo+IJuWGGc1K65k+ernDLbkZKeXGlLEo5Z5UDTWtZlSGl3mhl1fSuX177gpT+xgHpIQ059OL0u7NSmieT6vRnmiLnNcilZMfYc+PuQXcYBv7mCJdi5G/TsT9wpSxIKbcs+v6ehzjnTt9lVYaU3AqHXFy9T5LfipiR0t04sDvZPWu4FNqfa+DST1vPIfcjhs73cqJhLiW39443oGFHdVPvQocGrgfXmQpWyoKU1rW7ex58yaAzlYYbPKK/TNUu3VPkrfqqO51rRu/SPYWX8vJZrTWdgou+IE7KFWQFAAAArDG9rs3q8dfj9gPD0T9rWr6f+t856+pk+RkJa3nNqJOhhvarstdfePxM+Dd970I/iRePTK+vlDKGuPj4aKllASxleKHqr5GU8hPXBsTdpEaZ1h3qEIOTcqbwMqg5lN/Y0vwLEwFtTLsQQokHbky+7wfbbJh+lE821ImqboJ+6NcVdPPf5IH7xe3G6nvqfXTtwHDJJUCPipHpV5wSKlIOXNF74sRmrKOjM/R5TGPUtXGkgY7LyWzHmZBRPmjHkUMbm9dh+qGegaL3REo/QX+Qn0pHWMw/d3QcyI3V93QY360dGJ615OqRQmXlWeLFicqhuzcSmF2EwUkpbSCS1ZEK9IrDh8WQgpS5Yy0O01MuOthp8/plgv4oP5UeLQzR5WP1lsqvHeiVapZ9mco9M32+uG6jlxd4VkqZqxuqlP0gr9mwOxdSkJIbsk1Td8P09k1JO2Up5yfoi5SjIL9R02GD9UN5Hb15Jsp284HBciCtusECq5yTcmaR3byUBRvUqKdYZRA4c/dmOnLj74O+m9df+F5OWmUgp/Nj9TrxvT8sJimPwXBYmD7PDq6zQEpe3eQvhuakHBU8o/QhMyEipeow8sLZML2mDoO+W+hwYoK++MaCr+zndzF4mQGPwJuUNm5fprsMZ6bPSw+5SEq7u7VISnffWmqig9mFEO3YRIliqLZGij6gXDTrQXhygn7Isfr5XXkdxndWySPwzipt3L5UKTdiZsS14IqnMGwuQ0zFBwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAsAIqVaLmPzbqp8asVR+WT6uQyZZSIe3qTf+xIGWlNRtzoZRtTlpvlF2LawFLGeQWBSkvjpeyWa02VEpu8xQmDb9lzZ9eWiZlXYPob13eNzh+i4WutCiTdiB5cYNv84GyK3i1UjZIwwr9b7ZYypoLIRXarCYZXlMUlgRtemnVJIRk81YpUlJsdhacV4Pe0/HaNkmplsMCBa2Ga+CtikopNtussZqugdfESiWkXp+Tsi6vGpGiNbdIx0Cqzy2X22K1WhEpudU2TUoJbrOy3le2WfuWHGjMSdkSpSUsUCewTV7UGnjbOnGSslFRoxMp1a5Eynbe7Zi4QXC6lGq8atZbgnY7LfF9KiWHVJp6xHU17AOa5ivb4lStPxF965UZKc2zkt9Up7stiJQt6iCkJUu3wy23KQ25Jo29ou2/7bodabY1u7Sv8Affg6uUNYldC9RRgEvy8N9G4Bw0t6hlP0Ka1e3qugEAAAAAAAAAAADAljOOiCCYRFP9HMcLIiXxebKMkrIrVQ5jqnc8lrcTkvQSUqaZZbGtsJRTSLkKWMrxlIWYUksfeynpQ8qvMbd/ljIllRLnDCKJNaGPiYXy+0izoOymYwrkOBSScuqxZbfJsK/kOpNNFa2SXSe3+zH9T1jKccy60IcxxTO50ykftNDcKllKkngSZUEWTSR6ItlsOGyVSTovZSJNPppYg03icWzSBWyAkzytD52VMtXXOJHU+nnTETlIhTkp5W+aZSpBEomkKTdir68EjH3orJRjzZpdh2SWRE7/zeUUKc0qM2eVbLgiVjDbt1B0Cz1dSs0y2/geaaaBT1y9J85XprH5yjjVeEUpE9HcQqWhSxYFKdmPZuwrg9wtbCxj66rZpmLuwSPphybSFwfSfMeB9sGZHIxzKVPp0C2UO2vNoiAlHxtTau7kp2VXdQOIN77vviqmG9+yr4Spdu4AAAAAAAAAAAAAAAAAAAAAAAAAAABcFllsMj4RnEXZgsipzf9LMHllATJVNV5SmjTVmX1RCilPovPJ4/FSkVONNx3DKhegUsrsU1k6IrN+6Q+LxfPQMpm1atNM06m0+5QXPgTqGPyyklSnvGYce+xyC8bTaOMnTs9Kycql9C7KVNQJ/0t49nPG607c5Od0yvN/s5SPTjOZM+2XlUwlL34byGR/yY1ccdkVLEFKWQ+SJG76sy15sBn+8dSkZFEphkkbJ35ZiUSNdWkFpfe5bdGMX60rGZrMKqWmOpXJ5GaYga4Vi2wFaMorcdhuZfa+i+5nnfNU9sSktNzGWzQDXaXkxQyu54kC18bVKgvrG0nKLGW1zB/EuZS8RioxKenV5bZ1UqbST7hlzLJyjMTi9SVZNilcYfK1kPTeJnTBKvkQZaMr8cY+t62SMnId9MTmjUv3LE1YlopKnxzlUk5NaG7CBavkWHypRP4g5TDLbZukfBScbyU+OJ3FPzrBORFvACUBAAAAAAAAAAAAAAAAAAAAAAAAAMDKGV/wuacnplilWz+9xT3M+2Eskvo0Kbf4GckyVfUMs4SUS+GlTGXNSJxQi+c5qjzFdCqT0DN9cnqc703itiuxZSiJ2/cgi+LUr0+RicSTbZrXNtYp5TKXnGftywKRqTxmfypz0nWKvzgB2/XEbVdiy1B4R4MpSylTrWN5MH+mGUbRNj3Le6yWJTs8TGNRQhaKsJ2JZerCE5l6Pkm9+rKwRJeh2KIeWx4V21cjq6okZGvmUPuNHiK/WMRLyULw3ia2dsxNSXfblbhlKJl8GanuwiNSir90y1W2SUq2ItsN5iFWmTdTt11JoeeJeGuUNAnmrZITbc1VknY7U1mGMydl4n1lNrOg1G1XYstQMl2hR4pFJmPmfeX47CutzUGkZDenk8iLUvr9SBLuu8d+TZnbrsSWoWS6sYnsMpNy5525oEA2Kyu7hpvB1nTejx5IuTIgJQAAAAAAAAAAAAAAAAAAAAAAAAAAWBnpxRabLJX1dj3zl+ejZnPzcs89T3fBc5K3b7rQZNH0R0h5IfSZ6LrrTszzUdNA15dN5e8kyqIomfiFJhNZPzKRWahjmaGeuqUBEz+xNYp+RA7oaglbd5Jt/KzViT5WXif68pqHRK2SV5RMU3nyfsZy2QRrntgrM6sj94B/ea68TvGVHVD4Gf9TndEfJ4V1J6m+bjRiXmnm9yNRKXVDhIk4APan1oYnbqY+SySrTWTWepzvgGIt26ScWXcyXW6DpHWGLC7RTUgSsVGRUlaSZCelDEzKiQujDyKlLj1xztdJWVx3Mt38Gf5JLD5Q3vNaKJFymkt3QkqTZtYqi2a7wCo3XspM2jH7R650olJw455Gp0gZq3tkaSbeV44Dt/QkGI/VV+oivXzdycZLGbh9iaaF1SVZJKt2uOs9KeVUe3MxPtc9B5zM7YAiVwGyQIVbt193svlSOpbsEiYbfkGzCtLlLssh5VnE0ZIr4iElAAAAAAAAAAAAAAAAgK3lBvGY8bjyhPEh5WZOQP+fWMlpn3zqqafKrvqq+PBHPvqxH/34J37s1rl5+sefefa55z/5Ez/5qU//1Gc++7nP376z8AQvvHj38z/9My+99FLwsy+/QlHu/dzP/8Krv/jpT/3SFz753Bdfk5y+9Nwv/8rHPvqZX/2124+VLce5ef0jv/4bzxO/+VtfPr+Ep2v7xo0bdwg5xZsf/txv/87v/t7vf2U2zltvPTyPt//gq1/7w1f/6I/fWY3RP2q+/icr1G+xqE+/dtksvlG2SkvwzS88aiFXwjpI+adli7SklPfLFmpjpLz1Z39etlJn8qBsjZbmnbKlOoM7ZQu0PN8qW6tzSLmzu+ff7+4vXcX93RXqdXB46qHPlq3VOaQ8PDpasZRL53K0d3bsdZJyt1AZSHkZKfeObh0e85uD3d293f1jNlH6s7e7yw3/aI+CdyjokD7fklCuOR80KeXAAWtydMx5HO1QwIGE09+dA0qyR0HO8ungocuH/uz+hcSmEkhMjsXpqVB2xnWSkixj54BfD7n0+2IkBzu3DrlOFEofj+kwOwGqLn3ao08Hx3xEv4kDPsBVJzM9POQPkgUnoo87JNweK0TfyzN/KXIX8vFWyVKyxBRrn785SqEZr5OU0k6p9Du71jTFQHxD5apTFGvN/OnWwT7X0gVpOo56fHjr+Mg3cBZk/0Cz4vdq+SK2z2dOylvyenyoTcUyXiMpj7mVkUGofFStHWlupNQut2yu7P7uvol7JJF32Aa9r9zbNaUOdqRROimFE1JSFgc+n1kpD1Rpichn0IzXSErxcjtW531p3ftkLztmWU7K3byb0Ip6q9FUOwemNluspNXO5ISU4ogtn9OlVPOW4qyNlCYICar+j70c+0VWZC+XUi78yCWafNwhHZivtMZ8cCheUDIU6Y4WSnksWbt8pKHbUSclf4n77Cst47WR8kivjamT4BYttih+n9vgYUFK6ZvVHRxpJ2tfAvfFYke71pvv8HtrxMcnpDzSS4A8n32JXZCSjx3sHfmMr7uUwYMHD269/Fe3Vsfx4eXzWJjbtZdSWKWUYsqrYqeQ2zfLVumKpTwq/I6/tIzqJYyvlS3SVUv5SHj3r//mb8uWaGnKFusU3v67v/+Hf3znzuXrd4W8W7ZoJ/jK81/9p38uW5aLcP9f/vXfzlnXZ7741pffffa9t99///1vf/vtt99779ln//3iyj392oMv/cd/PvPWJz7+X//9jVe//j/3ylbkUtz7lnD3O69/93/v3/7ei/e+/84Hr7zxf2++8IOnnvzhzQ898fiNO3feeP07d18mgg9uLMriscefuHnzh08+9YMX3nzzjTde+eCd79978Xu379//7uuU7u7dgLK+f//2iy8Wcr55kzMuu+4AAAAAAAAAAAAAAAAAAAAAgEsyji66s0lsD2Kd2b+Et0vQvRSmkd8tQZ5SXSDNlj7JJJpPfH3hB3cn534ytD31/CT8kGl5xveY85yqZtlc/ueT8vy7g5SEbHBwbrN8qJT84O+kaErjuZjnlDJbk2eAeylTeX55nIylgU70ceZJHFPzT/TR6YnbmySzfUs0Kkua2vPRvZQzaskz0a3hU5okzSQa/bHQ8ZQyyOwUblMVeWa7POl+TTacYSn5Qf38RP10GsRUIy5+MpEdNJJoKk+nln1OosAbm1ilRbXtDRIvZWZbTzjEqmLdU0Ge7U8JWWpquBY65kfaUyzdFcU2VdFNBOSh9evRwsfuAf2sQ6x7PpgVUA0SqytXXZ6cXtxsw6KSlHlznka2Tc+8lJrKb4wi21b4vMZJvtGE31RFLHeyTlImYlqyawE1UnGA3NZS2RBhRsoo7+y9r6So/Bq7bYnc3gbFNpmpJn6jFM6M3nDeGipaTaKJiWubqsj+AWsmJduXsxynT6Rb7sxIWXB/81J6DZ2UceEKKUt1J6TASSlbdGTjzIXmUqpVqnIiZbZmUrJwtsuT6TORRjorZfGSyfYtcVImFquw44Z0Q3YxZL5vyqLF6mRJqDTIQ6e2pYrsijJ1LX/KjSNYq25HqqNNzelDXWk6Z5XciiMzNrdviUkZR5FtEZNvXjLOY9tWSCIhu2axb9efxwUp/a4ockHATidbo4uhq+CSWqxJ+74aLvXbL4ZRAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACw0fw/CR35C04cBcEAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjMtMDEtMTJUMTg6MzE6NDMrMDA6MDDmjo6JAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIzLTAxLTEyVDE4OjMxOjQzKzAwOjAwl9M2NQAAAABJRU5ErkJggg==)

Click **Environment Variables**.

![](https://docs.speedscale.com/assets/images/windows_add_path-environment_variables-805098f0523bb0aefc1f6527144f349c.png)

Under **System variables** select **Path** and click **Edit**.

![](https://docs.speedscale.com/assets/images/windows_add_path-edit_path-b8a9109a72b012ac58a0fc1151487e1f.png)

Create a **New** entry in the list with the Speedscale directory. If you are unsure of the exact path run this command from PowerShell.

```text
echo $env:userprofile\.speedscale
```

![](https://docs.speedscale.com/assets/images/windows_add_path-new_entry-7a908cf10a679dd05d3b128926fa78ff.png)

Click **OK** and restart PowerShell.

<a id="install-speedscale-operator-optional"></a>

## Install Speedscale Operator (optional)

If you are running Speedscale on your local desktop, you should continue directly to the [tutorial](https://docs.speedscale.com/tutorial/). The rest of this document is focused on installing a Kubernetes-based demo.

If you are using a common Kubernetes distribution (EKS, GKE, minikube, etc) then you can install using these instructions. If you are not running in Kubernetes, or are running with a more specialized enterprise distribution please select environment-specific [instructions](https://docs.speedscale.com/getting-started/installation/install/) in this section.

**Helm**

Make sure you have [Helm 3](https://helm.sh/docs/intro/install/) installed. Then,

```text
helm repo add speedscale https://speedscale.github.io/operator-helm/
helm repo update
helm install speedscale-operator speedscale/speedscale-operator \
	-n speedscale \
	--create-namespace \
	--set apiKey=<YOUR-SPEEDSCALE-API-KEY> \
	--set clusterName=<YOUR-CLUSTER-NAME>
```

Navigate to the [Helm repository](https://github.com/speedscale/operator-helm/blob/main/README.md) for all configuration options available for the Helm chart.

**speedctl (Mac/Linux)**

Run `speedctl install`, choose "Kubernetes" and follow the prompts.

The install wizard will walk you through installing the [Speedscale Kubernetes Operator](https://docs.speedscale.com/getting-started/installation/install/kubernetes-operator/).

Recommended next step: enable the [eBPF collector](https://docs.speedscale.com/reference/ebpf-traffic-collection/) to capture traffic in Kubernetes without proxies or app changes. If your environment or workload cannot use eBPF, fall back to the [Sidecar installation](https://docs.speedscale.com/getting-started/installation/sidecar/install/).

<a id="optional-adding-image-pull-secrets"></a>

### (Optional) Adding Image Pull Secrets

If you need custom image pull secrets (for example, if you're re-hosting Speedscale images in a dedicated registry), you may provide one or more secret names with the `--imgpullsecrets` argument, and the secrets will be attached to the service account.

```text
speedctl install --imgpullsecrets my-secret1,my-secret2p
```

**speedctl (Windows)**

If using Kubernetes run `speedctl install`, choose "Kubernetes" and follow the prompts. The install wizard will walk you through installing the [Speedscale Kubernetes Operator](https://docs.speedscale.com/getting-started/installation/install/kubernetes-operator/).

Recommended next step: enable the [eBPF collector](https://docs.speedscale.com/reference/ebpf-traffic-collection/) to capture traffic in Kubernetes. If eBPF is not suitable for your workload or kernel, use the [Sidecar installation](https://docs.speedscale.com/getting-started/installation/sidecar/install/) instead.

Speedscale can also be used with [Docker](https://docs.speedscale.com/getting-started/installation/install/docker/) and [locally with proxymock](https://docs.speedscale.com/proxymock/getting-started/quickstart/quickstart-cli/).

**ArgoCD**

Use the following ArgoCD manifest as an example. Make sure to use the latest `targetRevision` as shown on the [Helm repository](https://github.com/speedscale/operator-helm/blob/main/README.md).

```text
project: default
source:
  repoURL: 'https://speedscale.github.io/operator-helm/'
  targetRevision: <YOUR-VERSION>
  helm:
    parameters:
      - name: apiKeySecret
        value: speedscale-apikey
    values: |-
      apiKeySecret: speedscale-apikey
      clusterName: <YOUR-CLUSTER-NAME>
  chart: speedscale-operator
destination:
  namespace: speedscale
  name: in-cluster
syncPolicy:
  automated: {}
  syncOptions:
    - CreateNamespace=true
```

**GitOps**

caution

Installing via `helm install` is preferred as different GitOps engines treat Helm charts differently and Helm guarantees an order of operations during the install.

You can generate manifests either via Helm or [speedctl CLI](https://docs.speedscale.com/getting-started/installation/install/cli/).

```text
helm template speedscale-operator speedscale/speedscale-operator \
	-n speedscale \
	--create-namespace \
	--set apiKey=<YOUR-SPEEDSCALE-API-KEY> \
	--set clusterName=<YOUR-CLUSTER-NAME> > ./speedscale-operator.yaml
```

Then store `speedscale-operator.yaml` in git so it is deployed to your cluster.

<a id="verify-installation"></a>

### Verify Installation

Make sure the operator pods are running properly:

```text
kubectl -n speedscale get pods
```

Note: The Operator will start at least 2 pods (the operator itself and the Speedscale Forwarder) after it starts. On your cluster the ids of the pods will be different.

```text
NAME                                    READY   STATUS    RESTARTS   AGE
speedscale-forwarder-xxxxxxxxxx-xxxxx   1/1     Running   0          5s
speedscale-operator-xxxxxxxxxx-xxxxx    1/1     Running   0          15s
```

tip

If you have any issues installing, check out the [troubleshooting guide](https://docs.speedscale.com/getting-started/installation/install/troubleshooting/) or contact support on [slack](https://slack.speedscale.com/)

# Next Steps

For the proxymock CLI path, continue with [cluster capture and replay commands](https://docs.speedscale.com/proxymock/guides/cluster/). If proxymock is not installed yet, [install it first](https://docs.speedscale.com/proxymock/getting-started/installation/); the platform agent install already installs it.

At this point Speedscale is present in your cluster and you are now ready to target workloads for record and playback. If this is your first installation please continue using our multi-platform [tutorial](https://docs.speedscale.com/tutorial/) for a full walkthrough.

If you're already an expert you can click the `Add Service` button in the UI to target workloads for capture. Prefer enabling the [eBPF collector](https://docs.speedscale.com/reference/ebpf-traffic-collection/); if not possible, add sidecars [manually](https://docs.speedscale.com/getting-started/installation/sidecar/install/).
