Skip to main content
View as Markdown

Installing Keploy​

This guide walks you through installing the Keploy CLI, which enables you to record API calls and replay them as sandboxes for testing.

1. Install Keploy CLI​

Keploy captures your app's API calls and turns them into test cases and mocks/stubs. It runs natively on Linux, macOS (Apple Silicon) and Windows (x86-64). Choose your OS to get started 🚀


info

Make sure your Linux kernel version is 5.10 or higher.

👉 Choose your preferred method:


1. Install Keploy CLI​

curl --silent -O -L https://keploy.io/install.sh && source install.sh

2. Once done, you should see something like this:​

🐰 Keploy: 2026-05-05T08:23:30.09586779Z        INFO    Starting Keploy {"version": "3.4.1", "buildSource": "unknown", "apiServerURL": "https://api.keploy.io", "inDocker": false}

       ▓██▓▄
    ▓▓▓▓██▓█▓▄
     ████████▓▒
          ▀▓▓███▄      ▄▄   ▄               ▌
         ▄▌▌▓▓████▄    ██ ▓█▀  ▄▌▀▄  ▓▓▌▄   ▓█  ▄▌▓▓▌▄ ▌▌   ▓
       ▓█████████▌▓▓   ██▓█▄  ▓█▄▓▓ ▐█▌  ██ ▓█  █▌  ██  █▌ █▓
      ▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌  ██  █▓  ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀   █▓█
       ▓▌                           ▐█▌                   █▌
        ▓

Keploy: 3.4.1

Keploy CLI

Usage:
  keploy [command]

Available Commands:
  agent             starts keploy agent for hooking and starting proxy
  cloud             Manage cloud operations
  config            manage keploy configuration file
  console           manage keploy console file
  contract          Manage keploy contracts
  create-branch     Create a new branch on a Keploy app
  create-test-suite Validate a test suite spec from JSON and insert it via api-server
  debug             Debug and reproduce Keploy failures locally
  dedup             manage keploy dedup file
  diff              compare two keploy test runs and print regressions/fixes
  example           Example to record and test via keploy
  export            export Keploy tests as postman collection
  import            import postman collection to Keploy tests
  list-branches     List branches on a Keploy app
  login             Authenticate with your Keploy account
  logout            Sign out of your Keploy account
  mock              Managing mocks
  normalize         Normalize Keploy
  record            record end to end api-calls
  report            report the keploy test results from the API calls
  sanitize          sanitize the keploy testcases to remove the sensitive data
  templatize        templatize the keploy testcases
  test              run the recorded testcases and execute assertions
  test-gen          AI agent-based API test generation — run, coverage, init
  test-suite        Run keploy test suites
  test-suite-format Print the canonical test-suite step schema
  ui                Manage UI flow capture, testing, and reporting
  update            update keploy to latest version
  update-test-suite Validate edits to a test suite and snapshot-replace it via api-server

Flags:
      --config-path string   Path to the local directory where keploy configuration file is stored (default ".")
      --debug                Run in debug mode
      --disable-ansi         Disable ANSI color in logs
  -h, --help                 help for keploy
      --json                 Print output in JSON format
      --manual-login         Use manual login prompt instead of opening browser
  -v, --version              version for keploy

Guided Commands:
  help              Help about any command

Examples:

  Record:
        keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60

  Test:
        keploy test --c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --delay 10 --buildDelay 60

  Config:
        keploy config --generate -p "/path/to/localdir"


Use "keploy [command] --help" for more information about a command.

2. Log in to Keploy​

After installing, authenticate with your Keploy account. Choose the method that fits your setup:

Keploy opens a browser window to sign you in automatically:

keploy login
Opening browser for authentication...

If the browser does not open automatically, please visit:
https://app.keploy.io/signin/integration/auth?method=code&code=<YOUR_CODE>

Waiting for authentication...
Logged in successfully!

Now you can start using Keploy to record API calls and replay them as sandboxes for testing your application.

To explore what's available at each tier, visit keploy.io/pricing.

🎉 Congratulations!​

You’ve successfully installed Keploy on Linux.

🎬 Start Capturing Test Cases


Record the test cases

keploy record -c "go run main.go"

Run the test cases

keploy test -c "go run main.go" --delay 10

📖 What’s Next?

Now, take it further by following the Quickstart Guide and see Keploy in action with your app.