From 96eaa7007c8a7a5d888c773557f569dd7b589b7f Mon Sep 17 00:00:00 2001 From: kirti763 Date: Fri, 27 Feb 2026 19:04:08 +0530 Subject: [PATCH 1/8] docs: add proprietary CLI installation page Signed-off-by: kirti763 --- .../version-4.0.0/server/installation_tabs.md | 138 ++++++++++++++++++ 1 file changed, 138 insertions(+) diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index fc99df2b5..845b6cb73 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -27,7 +27,145 @@ import StartKeployDocker from '@site/src/components/StartKeployDocker'; # Installing Keploy +Keploy captures real API calls and database interactions, then helps you replay them as tests without rebuilding your full production environment. Keploy uses eBPF to intercept API calls at the network layer and generate test cases and mocks/stubs. + +## Choose your setup path + +### Recommended: Keploy Proprietary CLI + +Use this if you want the fastest setup, browser-based sign-in, and access to Keploy’s proprietary capabilities. + +### Open-source only + +Use this if you want the pure OSS route and are okay with a more manual setup. +The recommended path below should be the default experience across docs, keploy.io, and GitHub. + +--- + +## Recommended Setup: Keploy Proprietary CLI + +This is the preferred way to install and use Keploy. +With this setup: +* you install the recommended Keploy binary +* you start using Keploy immediately +* if authentication is required, Keploy opens a browser and signs you in automatically +* you do not need to manually fetch or paste an API key +* once the flow is complete, Keploy is ready to use for record and test + +## How authentication works + +Keploy uses an **auto-login flow** for the recommended CLI experience. +When you run a command like: +* `keploy record` +* `keploy test` + +and you are not already signed in, Keploy will: +1. open a browser window +2. ask you to sign in +3. return you to the CLI automatically +4. complete authentication in the background + +Commands like `keploy --help` and `keploy --version` should not trigger login. + +**Placeholder for final wording:** Confirm exact product language once Gourav finalizes the binary and auth flow. + +--- + +## Install the recommended Keploy CLI + +Follow the step below to install the Keploy Enterprise Agent: + +```bash +curl --silent -O -L https://keploy.io/ent/install.sh && source install.sh +``` + +## Record Your First Test + +Once Keploy is installed, run your application through Keploy. +This captures your real API calls and database interactions. +`keploy record -c "YOUR_START_COMMAND"` + +Example: +`keploy record -c "npm start"` +or +`keploy record -c "go run main.go"` + +If you are not authenticated yet, the recommended CLI will automatically open the browser login flow and continue after sign-in. + +--- + +## Replay and Verify + +After recording is complete, stop your app and run: + +```bash +keploy test -c "YOUR_START_COMMAND" --delay 10 +``` + +Keploy will replay the captured traffic so you can run your tests without depending on the original database or external services. + +## Automatic Cloud / Sandbox Behavior + +Cloud backup and sandbox sync will be documented here very soon, once the rollout is live. + +--- + +## Why this is the recommended path + +Use the recommended Keploy CLI if you want: +* the easiest install experience +* built-in browser-based authentication +* less manual setup +* access to proprietary Keploy capabilities +* a smoother path for integrations and team workflows + +## Which path should I choose? + +:::info +The Open Source version is best for **HTTP / REST** protocol. +If you need support for **gRPC, Redis, GraphQL, webhooks, and advanced integration workflows,** use the **Proprietary** version. +For broader framework and protocol support, we recommend installing **Paid / Pro**. +::: + +### Feature Comparison + +| Feature | Open Source | Paid / Pro | +|---------|-------------|------------| +| **Core Testing** | | | +| Record & Replay | Yes | Yes | +| GraphQL Support | Yes | Yes | +| REST API Testing | Yes | Yes | + +| **Advanced Integrations** | | | +| gRPC Incoming | Yes | Yes | +| gRPC Outgoing | No | Yes | +| Redis Support | No | Yes | + +| **Workflow & Automation** | | | +| CI/CD Integration | Yes | Yes | +| Implicit CLI Auto-Login | No | Yes | +| Automated Sandbox Push | No | Yes | +| Webhook Support | No | Yes | +| Sandbox Registry | No | Yes | + +| **Enterprise Intelligence** | | | +| AI-Driven Test Generation | No | Yes | +| Test Deduplication | No | Yes | +| Time Freezing | No | Yes | +| Asynchronous Process Support | No | Yes | +| Keploy Console | No | Yes | + +| **Enterprise & Support** | | | +| Team Collaboration | No | Yes | +| SSO Integration | No | Yes | +| Priority Support | No | Yes | +| Unlimited Test Runs | No | Yes | + +--- + +## Setup: Open-source only + Choose your OS to get started 🚀 From 9fc9a908eaa942332dc4e33a9b4ee6a5c42ebaff Mon Sep 17 00:00:00 2001 From: kirti763 Date: Fri, 27 Feb 2026 19:18:00 +0530 Subject: [PATCH 2/8] docs: updated table Signed-off-by: kirti763 --- .../version-4.0.0/server/installation_tabs.md | 43 ++++++------------- 1 file changed, 12 insertions(+), 31 deletions(-) diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index 845b6cb73..890807055 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -130,37 +130,18 @@ For broader framework and protocol support, we recommend installing **Paid / Pro ### Feature Comparison -| Feature | Open Source | Paid / Pro | -|---------|-------------|------------| -| **Core Testing** | | | -| Record & Replay | Yes | Yes | -| GraphQL Support | Yes | Yes | -| REST API Testing | Yes | Yes | - -| **Advanced Integrations** | | | -| gRPC Incoming | Yes | Yes | -| gRPC Outgoing | No | Yes | -| Redis Support | No | Yes | - -| **Workflow & Automation** | | | -| CI/CD Integration | Yes | Yes | -| Implicit CLI Auto-Login | No | Yes | -| Automated Sandbox Push | No | Yes | -| Webhook Support | No | Yes | -| Sandbox Registry | No | Yes | - -| **Enterprise Intelligence** | | | -| AI-Driven Test Generation | No | Yes | -| Test Deduplication | No | Yes | -| Time Freezing | No | Yes | -| Asynchronous Process Support | No | Yes | -| Keploy Console | No | Yes | - -| **Enterprise & Support** | | | -| Team Collaboration | No | Yes | -| SSO Integration | No | Yes | -| Priority Support | No | Yes | -| Unlimited Test Runs | No | Yes | +| Category | Feature | Open Source | Paid / Pro | +|-----------|---------|-------------|------------| +| Core Testing | Record & Replay | Yes | Yes | +| Core Testing | GraphQL Support | Yes | Yes | +| Core Testing | REST API Testing | Yes | Yes | +| Advanced Integrations | gRPC Incoming | Yes | Yes | +| Advanced Integrations | gRPC Outgoing | No | Yes | +| Advanced Integrations | Redis Support | No | Yes | +| Workflow & Automation | CI/CD Integration | Yes | Yes | +| Workflow & Automation | Implicit CLI Auto-Login | No | Yes | +| Enterprise Intelligence | AI-Driven Test Generation | No | Yes | +| Enterprise & Support | Team Collaboration | No | Yes | --- From 207ca25680a07074a07f278903d809c22a8c528b Mon Sep 17 00:00:00 2001 From: kirti763 Date: Fri, 27 Feb 2026 19:45:40 +0530 Subject: [PATCH 3/8] docs: update the table Signed-off-by: kirti763 --- .../version-4.0.0/server/installation_tabs.md | 47 +++++++++++++------ 1 file changed, 32 insertions(+), 15 deletions(-) diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index 890807055..5091168a6 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -34,11 +34,11 @@ Keploy uses eBPF to intercept API calls at the network layer and generate test c ### Recommended: Keploy Proprietary CLI -Use this if you want the fastest setup, browser-based sign-in, and access to Keploy’s proprietary capabilities. +Use this if you want the **fastest setup**, **browser-based sign-in**, and access to Keploy's Enterprise capabilities. ### Open-source only -Use this if you want the pure OSS route and are okay with a more manual setup. +Use this if you want the **pure OSS route** and are okay with a more manual setup. The recommended path below should be the default experience across docs, keploy.io, and GitHub. --- @@ -46,6 +46,7 @@ The recommended path below should be the default experience across docs, keploy. ## Recommended Setup: Keploy Proprietary CLI This is the preferred way to install and use Keploy. + With this setup: * you install the recommended Keploy binary * you start using Keploy immediately @@ -124,24 +125,40 @@ Use the recommended Keploy CLI if you want: :::info The Open Source version is best for **HTTP / REST** protocol. + If you need support for **gRPC, Redis, GraphQL, webhooks, and advanced integration workflows,** use the **Proprietary** version. -For broader framework and protocol support, we recommend installing **Paid / Pro**. + +For broader framework and protocol support, we recommend installing Keploy Enterprise. ::: ### Feature Comparison -| Category | Feature | Open Source | Paid / Pro | -|-----------|---------|-------------|------------| -| Core Testing | Record & Replay | Yes | Yes | -| Core Testing | GraphQL Support | Yes | Yes | -| Core Testing | REST API Testing | Yes | Yes | -| Advanced Integrations | gRPC Incoming | Yes | Yes | -| Advanced Integrations | gRPC Outgoing | No | Yes | -| Advanced Integrations | Redis Support | No | Yes | -| Workflow & Automation | CI/CD Integration | Yes | Yes | -| Workflow & Automation | Implicit CLI Auto-Login | No | Yes | -| Enterprise Intelligence | AI-Driven Test Generation | No | Yes | -| Enterprise & Support | Team Collaboration | No | Yes | +### Feature Comparison + +### Feature Comparison + +| Feature | Open Source | Enterprise | +|---------|-------------|------------| +| **Dependencies** | | | +| HTTP | Yes | Yes | +| MySQL | Yes | Yes | +| gRPC Outgoing | No | Yes | +| Mongo | No | Yes | +| Postgres | No | Yes | +| Redis | No | Yes | +| SQS | No | Yes | +| Kafka | No | Yes | +| HTTP2 | No | Yes | + +| **Incoming Tests** | | | +| HTTP | Yes | Yes | +| gRPC Incoming | Yes | Yes | + +| **Extra Features** | | | +| Mock Upload | No | Yes | +| Time Freezing | No | Yes | +| Deduplication (Static + Codepath) | No | Yes | +| Sandboxing for Existing E2E / Integration Tests | No | Yes | --- From 3d3799e7dc89c9b30094e847a285324fdf35efee Mon Sep 17 00:00:00 2001 From: kirti763 Date: Fri, 27 Feb 2026 19:55:31 +0530 Subject: [PATCH 4/8] docs: update toc Signed-off-by: kirti763 --- versioned_docs/version-4.0.0/server/installation_tabs.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index 5091168a6..c50499a4d 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -3,7 +3,7 @@ id: installation title: Installing Keploy sidebar_label: Installation description: Installation guide for Keploy on Linux, macOS, and Windows. -hide_table_of_contents: true +hide_table_of_contents: false tags: - installation keywords: @@ -133,10 +133,6 @@ For broader framework and protocol support, we recommend installing Keploy Enter ### Feature Comparison -### Feature Comparison - -### Feature Comparison - | Feature | Open Source | Enterprise | |---------|-------------|------------| | **Dependencies** | | | From e47a471726cf49822e92093fd93df0ab05787b38 Mon Sep 17 00:00:00 2001 From: kirti763 Date: Fri, 27 Feb 2026 23:50:31 +0530 Subject: [PATCH 5/8] docs: updates Signed-off-by: kirti763 --- .../version-4.0.0/server/installation_tabs.md | 110 +++++++++--------- 1 file changed, 57 insertions(+), 53 deletions(-) diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index c50499a4d..e515928fb 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -18,6 +18,7 @@ keywords: import ProductTier from '@site/src/components/ProductTier'; + import Tabs from '@theme/Tabs'; @@ -25,25 +26,22 @@ import TabItem from '@theme/TabItem'; import StartKeploy from '@site/src/components/StartKeploy'; import StartKeployDocker from '@site/src/components/StartKeployDocker'; -# Installing Keploy +# Install Keploy Keploy captures real API calls and database interactions, then helps you replay them as tests without rebuilding your full production environment. -Keploy uses eBPF to intercept API calls at the network layer and generate test cases and mocks/stubs. ## Choose your setup path -### Recommended: Keploy Proprietary CLI +:::info +#### Recommended: Keploy Enterprise CLI Use this if you want the **fastest setup**, **browser-based sign-in**, and access to Keploy's Enterprise capabilities. +::: -### Open-source only - -Use this if you want the **pure OSS route** and are okay with a more manual setup. -The recommended path below should be the default experience across docs, keploy.io, and GitHub. - ---- +## Keploy Enterprise CLI -## Recommended Setup: Keploy Proprietary CLI +
+Keploy Enterprise CLI This is the preferred way to install and use Keploy. @@ -51,12 +49,10 @@ With this setup: * you install the recommended Keploy binary * you start using Keploy immediately * if authentication is required, Keploy opens a browser and signs you in automatically -* you do not need to manually fetch or paste an API key * once the flow is complete, Keploy is ready to use for record and test -## How authentication works +### How authentication works -Keploy uses an **auto-login flow** for the recommended CLI experience. When you run a command like: * `keploy record` * `keploy test` @@ -65,13 +61,7 @@ and you are not already signed in, Keploy will: 1. open a browser window 2. ask you to sign in 3. return you to the CLI automatically -4. complete authentication in the background - -Commands like `keploy --help` and `keploy --version` should not trigger login. - -**Placeholder for final wording:** Confirm exact product language once Gourav finalizes the binary and auth flow. - ---- +
## Install the recommended Keploy CLI @@ -85,7 +75,10 @@ curl --silent -O -L https://keploy.io/ent/install.sh && source install.sh Once Keploy is installed, run your application through Keploy. This captures your real API calls and database interactions. -`keploy record -c "YOUR_START_COMMAND"` + +```bash +keploy record -c "YOUR_START_COMMAND" +``` Example: `keploy record -c "npm start"` @@ -94,7 +87,6 @@ or If you are not authenticated yet, the recommended CLI will automatically open the browser login flow and continue after sign-in. ---- ## Replay and Verify @@ -112,53 +104,65 @@ Cloud backup and sandbox sync will be documented here very soon, once the rollou --- -## Why this is the recommended path - -Use the recommended Keploy CLI if you want: +## Why this is the recommended path? +
+Why this is recommended path? +Use the recommended Keploy Enterprise CLI if you want: * the easiest install experience * built-in browser-based authentication * less manual setup -* access to proprietary Keploy capabilities +* access to Enterprise Keploy capabilities * a smoother path for integrations and team workflows +
## Which path should I choose? :::info The Open Source version is best for **HTTP / REST** protocol. -If you need support for **gRPC, Redis, GraphQL, webhooks, and advanced integration workflows,** use the **Proprietary** version. +If you need support for **gRPC, Redis, GraphQL, webhooks, and advanced integration workflows,** use the **Enterprise** version. For broader framework and protocol support, we recommend installing Keploy Enterprise. ::: ### Feature Comparison -| Feature | Open Source | Enterprise | -|---------|-------------|------------| -| **Dependencies** | | | -| HTTP | Yes | Yes | -| MySQL | Yes | Yes | -| gRPC Outgoing | No | Yes | -| Mongo | No | Yes | -| Postgres | No | Yes | -| Redis | No | Yes | -| SQS | No | Yes | -| Kafka | No | Yes | -| HTTP2 | No | Yes | - -| **Incoming Tests** | | | -| HTTP | Yes | Yes | -| gRPC Incoming | Yes | Yes | - -| **Extra Features** | | | -| Mock Upload | No | Yes | -| Time Freezing | No | Yes | -| Deduplication (Static + Codepath) | No | Yes | -| Sandboxing for Existing E2E / Integration Tests | No | Yes | - ---- - -## Setup: Open-source only + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureOpen SourceEnterprise
Dependencies
HTTPYesYes
MySQLYesYes
gRPC OutgoingNoYes
MongoNoYes
PostgresNoYes
RedisNoYes
SQSNoYes
KafkaNoYes
HTTP2NoYes
Incoming Tests
HTTPYesYes
gRPC IncomingYesYes
Extra Features
Mock UploadNoYes
Time FreezingNoYes
Deduplication (Static + Codepath)NoYes
Sandboxing for Existing E2E / Integration TestsNoYes
+ +## Setup: Open-source Choose your OS to get started 🚀 From dae462d3acff410465590bbd0fa383a2e1eb85b3 Mon Sep 17 00:00:00 2001 From: kirti763 Date: Sat, 28 Feb 2026 11:51:32 +0530 Subject: [PATCH 6/8] fix: table structure Signed-off-by: kirti763 --- .../version-4.0.0/server/installation_tabs.md | 54 +++++++------------ 1 file changed, 20 insertions(+), 34 deletions(-) diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index e515928fb..5bca169e0 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -127,40 +127,26 @@ For broader framework and protocol support, we recommend installing Keploy Enter ### Feature Comparison - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FeatureOpen SourceEnterprise
Dependencies
HTTPYesYes
MySQLYesYes
gRPC OutgoingNoYes
MongoNoYes
PostgresNoYes
RedisNoYes
SQSNoYes
KafkaNoYes
HTTP2NoYes
Incoming Tests
HTTPYesYes
gRPC IncomingYesYes
Extra Features
Mock UploadNoYes
Time FreezingNoYes
Deduplication (Static + Codepath)NoYes
Sandboxing for Existing E2E / Integration TestsNoYes
+| Feature | Open Source | Enterprise | +|----------|-------------|------------| +| **Dependencies** | | | +| HTTP | Yes | Yes | +| MySQL | Yes | Yes | +| gRPC Outgoing | No | Yes | +| Mongo | No | Yes | +| Postgres | No | Yes | +| Redis | No | Yes | +| SQS | No | Yes | +| Kafka | No | Yes | +| HTTP2 | No | Yes | +| **Incoming Tests** | | | +| HTTP | Yes | Yes | +| gRPC Incoming | Yes | Yes | +| **Extra Features** | | | +| Mock Upload | No | Yes | +| Time Freezing | No | Yes | +| Deduplication (Static + Codepath) | No | Yes | +| Sandboxing for Existing E2E / Integration Tests | No | Yes | ## Setup: Open-source From 951bec43df68eb2e357e6eccdb5001eaa81ff3e8 Mon Sep 17 00:00:00 2001 From: kirti763 Date: Sat, 28 Feb 2026 12:04:59 +0530 Subject: [PATCH 7/8] fix: fixed enterprise tab Signed-off-by: kirti763 --- versioned_docs/version-4.0.0/server/installation_tabs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index 5bca169e0..0c6531fcb 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -18,7 +18,7 @@ keywords: import ProductTier from '@site/src/components/ProductTier'; - + import Tabs from '@theme/Tabs'; From bb928e010a261264b4a36c75124a5d2747dbadae Mon Sep 17 00:00:00 2001 From: kirti763 Date: Sun, 1 Mar 2026 20:36:45 +0530 Subject: [PATCH 8/8] fix: enterprise alignment Signed-off-by: kirti763 --- .../version-4.0.0/server/installation_tabs.md | 69 ++++++++++++------- 1 file changed, 44 insertions(+), 25 deletions(-) diff --git a/versioned_docs/version-4.0.0/server/installation_tabs.md b/versioned_docs/version-4.0.0/server/installation_tabs.md index 0c6531fcb..897b027a4 100644 --- a/versioned_docs/version-4.0.0/server/installation_tabs.md +++ b/versioned_docs/version-4.0.0/server/installation_tabs.md @@ -41,7 +41,7 @@ Use this if you want the **fastest setup**, **browser-based sign-in**, and acces ## Keploy Enterprise CLI
-Keploy Enterprise CLI +Know More This is the preferred way to install and use Keploy. @@ -87,7 +87,6 @@ or If you are not authenticated yet, the recommended CLI will automatically open the browser login flow and continue after sign-in. - ## Replay and Verify After recording is complete, stop your app and run: @@ -102,11 +101,11 @@ Keploy will replay the captured traffic so you can run your tests without depend Cloud backup and sandbox sync will be documented here very soon, once the rollout is live. ---- +## Why is this the recommended path? -## Why this is the recommended path?
-Why this is recommended path? +Know More + Use the recommended Keploy Enterprise CLI if you want: * the easiest install experience * built-in browser-based authentication @@ -127,26 +126,46 @@ For broader framework and protocol support, we recommend installing Keploy Enter ### Feature Comparison -| Feature | Open Source | Enterprise | -|----------|-------------|------------| -| **Dependencies** | | | -| HTTP | Yes | Yes | -| MySQL | Yes | Yes | -| gRPC Outgoing | No | Yes | -| Mongo | No | Yes | -| Postgres | No | Yes | -| Redis | No | Yes | -| SQS | No | Yes | -| Kafka | No | Yes | -| HTTP2 | No | Yes | -| **Incoming Tests** | | | -| HTTP | Yes | Yes | -| gRPC Incoming | Yes | Yes | -| **Extra Features** | | | -| Mock Upload | No | Yes | -| Time Freezing | No | Yes | -| Deduplication (Static + Codepath) | No | Yes | -| Sandboxing for Existing E2E / Integration Tests | No | Yes | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureOpen SourceEnterprise
Dependencies
HTTPYesYes
MySQLYesYes
gRPC OutgoingNoYes
MongoNoYes
PostgresNoYes
RedisNoYes
SQSNoYes
KafkaNoYes
HTTP2NoYes
Incoming Tests
HTTPYesYes
gRPC IncomingYesYes
Extra Features
Mock UploadNoYes
Time FreezingNoYes
Deduplication (Static + Codepath)NoYes
Sandboxing for Existing E2E / Integration TestsNoYes
## Setup: Open-source