Command-line tools (CLI): proxymock and speedctl

Speedscale has two command-line tools: proxymock and speedctl. Start with proxymock for new workflows that record traffic, mock dependencies, and replay tests. Use speedctl for platform setup, managing Speedscale Cloud resources, and existing scripts that call speedctl commands.

First choose where your traffic is now and where you want to test it. Traffic recorded on your machine, snapshots in Speedscale Cloud, and recordings in a BYOC bucket can all feed proxymock workflows. Installing the operator is a separate prerequisite when capture or replay will run in Kubernetes.

Choose a CLI for your task

Traffic and destination	Steps
Your app to local recordings	1. Install proxymock CLI. 2. Follow the proxymock CLI quickstart.
Speedscale Cloud snapshot to your laptop	1. Install proxymock and reuse your cloud credentials. 2. Pull the snapshot and replay it locally.
Kubernetes workload to capture or replay in your cluster	1. Install and verify the operator, or verify your existing BYOC deployment. 2. Install proxymock and follow cluster commands. 3. Choose the in-cluster replay path.
BYOC bucket to your machine or cluster	1. Install proxymock CLI. 2. Pull BYOC traffic. 3. Choose where the replay runs.
Recorded traffic to CI/CD	1. Record locally or pull a cloud snapshot. 2. Follow proxymock CI/CD setup, including its account requirements.
Recordings to a cloud-managed cluster replay	1. Install the operator if needed. 2. Use proxymock cloud replay. Existing speedctl infra replay scripts can follow Replay with speedctl.
Platform setup in Kubernetes	Follow the platform quick start. Choose Helm, GitOps, or the speedctl CLI install method.
Existing script to Speedscale Cloud resources	Install speedctl CLI, reuse your tenant credentials, and use speedctl --help for its commands.

Start with proxymock

For a local record/mock/replay workflow, install proxymock alone. Initialize it once with proxymock init, or reuse your existing speedctl credentials, then work through the quickstart with your application. Local recording requires one-time activation, and recorded traffic stays on your machine by default. See data and privacy for details.

• Install proxymock CLI: installation and initialization for macOS, Linux, and Windows.
• proxymock CLI quickstart: a complete record, mock, and replay loop with a demo app.
• proxymock CLI overview: the core commands and how traffic moves through the proxies.
• proxymock CLI reference: command syntax, flags, and examples. Run proxymock --help or proxymock <command> --help for the help shipped with your installed version.

Prefer to work with an agent or a UI? The agent tutorials, MCP server, and proxymock web use the same proxymock workflows.

Use speedctl for platform workflows

speedctl installs and configures platform components, works with cloud resources, and supports capture and replay workflows used by existing integrations. Keep using the commands a speedctl guide or script specifies; proxymock has its own command names and flags.

• Install speedctl CLI: installation for macOS, Linux, and Windows.
• Capture, replay, and mock with speedctl: the walkthrough for existing speedctl workflows.
• Replay with speedctl: cloud-managed cluster replays and replay options.
• Manage DLP rules with speedctl: pull and push platform DLP rules.

Run speedctl --help to list commands and speedctl <command> --help to see the flags available in your installed version.

Do I need both CLIs?

For a manual install, install the tool your chosen workflow calls for. Local proxymock recording, mocking, and replaying use proxymock. If your deployment or automation also calls speedctl, install both.

For an agent-assisted install, choose the scope of the prompt:

• proxymock only: the local proxymock agent install installs proxymock and its MCP server, with no operator.
• Platform setup: the platform agent install deliberately installs both CLIs, Kubernetes prerequisites, and the operator when requested. It prepares the full platform toolset; the install-one guidance above applies to manual installation.

Installing a CLI on your machine is separate from installing the operator in a cluster. For cluster setup, continue with the platform quick start or BYOC Kubernetes setup.

Credentials: do I initialize both?

Both CLIs use ~/.speedscale as their default configuration directory. Reusing credentials requires both clients to select the same configuration file and account context. Check which file each installed client uses without printing credentials:

proxymock version --client
speedctl version --client

Compare the ConfigFile paths. Older clients use config.yaml; newer clients prefer config.json and fall back to YAML. If the paths differ, align the clients' versions and configure both to use the same file. Both accept --config <path> and --context <name> for an explicit file and account context. Use the same overrides with both clients when you need them. A custom home or config path can make their settings separate.

With the same file and account context selected, initialize once with either proxymock init or speedctl init. If speedctl is already configured for your enterprise tenant, proxymock can reuse that configuration. Installing the second binary does not require registering another email or running init again.

The account in that configuration determines your access. Free proxymock activation enables local workflows; accessing a tenant's cloud snapshots requires credentials for that tenant. Follow enterprise account setup for sign-in and API-key options. If the file already contains credentials for another account, replace the existing configuration. proxymock init --api-key alone keeps an existing configuration. Changing the shared credentials affects both CLIs.