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 897b027a4..fc99df2b5 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: false +hide_table_of_contents: true tags: - installation keywords: @@ -18,7 +18,6 @@ keywords: import ProductTier from '@site/src/components/ProductTier'; - import Tabs from '@theme/Tabs'; @@ -26,149 +25,9 @@ import TabItem from '@theme/TabItem'; import StartKeploy from '@site/src/components/StartKeploy'; import StartKeployDocker from '@site/src/components/StartKeployDocker'; -# Install Keploy - -Keploy captures real API calls and database interactions, then helps you replay them as tests without rebuilding your full production environment. - -## Choose your setup path - -:::info -#### Recommended: Keploy Enterprise CLI - -Use this if you want the **fastest setup**, **browser-based sign-in**, and access to Keploy's Enterprise capabilities. -::: - -## Keploy Enterprise CLI - -
-Know More - -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 -* once the flow is complete, Keploy is ready to use for record and test - -### How authentication works - -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 -
- -## 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. - -```bash -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 is this the recommended path? - -
-Know More - -Use the recommended Keploy Enterprise CLI if you want: -* the easiest install experience -* built-in browser-based authentication -* less manual setup -* 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 **Enterprise** version. - -For broader framework and protocol support, we recommend installing Keploy Enterprise. -::: - -### 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
- -## Setup: Open-source +# Installing Keploy +Keploy uses eBPF to intercept API calls at the network layer and generate test cases and mocks/stubs. Choose your OS to get started 🚀