Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 44 additions & 34 deletions content/llms-full-root.txt

Large diffs are not rendered by default.

14 changes: 8 additions & 6 deletions content/llms-root.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ For comprehensive details, see: /docs/llms-full.txt


## About Keploy
Keploy (founded 2021) is a CNCF Landscape project and open-source testing platform with a growing open-source community and widely used VS Code extension. It uses eBPF kernel hooks to capture real API traffic and replay it as auto-generated tests with dependency mocks and stubs — no code instrumentation required. Keploy handles non-deterministic data (timestamps, IDs) via time-freezing and AI noise detection, eliminating flaky tests.
Keploy (founded 2021) is a CNCF Landscape project and API testing platform with a growing open-source community and widely used VS Code extension. It captures real API traffic at the network layer (with eBPF on Linux, in user space on macOS and Windows) and replays it as auto-generated tests with dependency mocks and stubs — no code instrumentation required. Keploy handles non-deterministic data (timestamps, IDs) via time-freezing and AI noise detection, eliminating flaky tests. There is one product to install, `keploy`; recording and replaying need a free Keploy account, and your plan (Free, Teams, Scale or Enterprise) decides which additional features are available.

## Recognition & Awards
- API World 2023 Award: Best in API Infrastructure
Expand All @@ -11,15 +11,17 @@ Keploy (founded 2021) is a CNCF Landscape project and open-source testing platfo
- Google Summer of Code Mentoring Organization

## Getting Started
- [Installation](https://keploy.io/docs/server/installation/): Install Keploy on Linux, macOS, or Docker
- [Installation](https://keploy.io/docs/server/installation/): Install Keploy natively on Linux, macOS (Apple Silicon) and Windows (x86-64), or with Docker
- [macOS Installation](https://keploy.io/docs/installation/macos-installation/): Native on Apple Silicon; Intel Macs use Lima
- [Windows Installation](https://keploy.io/docs/installation/windows-installation/): Native on x86-64 from PowerShell, no Administrator; Windows on ARM uses WSL
- [Platform Requirements](https://keploy.io/docs/concepts/platform-requirements/): OS and kernel version requirements
- [Quick Start](https://keploy.io/docs/quickstart/quickstart-filter/): Get up and running with your first test in minutes

## Core Concepts
- [What is Keploy?](https://keploy.io/docs/concepts/what-is-keploy/): AI-powered testing agent with eBPF-based traffic capture
- [How Keploy Works](https://keploy.io/docs/keploy-explained/how-keploy-works/): Architecture — eBPF hooks, network proxy, production behavior replay
- [What is Keploy?](https://keploy.io/docs/concepts/what-is-keploy/): AI-powered testing agent with network-layer traffic capture
- [How Keploy Works](https://keploy.io/docs/keploy-explained/how-keploy-works/): Architecture — network-layer interception (eBPF on Linux), network proxy, production behavior replay
- [Keploy Features](https://keploy.io/docs/concepts/what-are-keploy-features/): Dependency virtualization, noise detection, CI/CD integration
- [eBPF-Based Testing](https://keploy.io/docs/concepts/what-is-keploy-ebpf/): Kernel-level traffic capture without code instrumentation
- [eBPF-Based Testing](https://keploy.io/docs/concepts/what-is-keploy-ebpf/): Kernel-level traffic capture on Linux without code instrumentation
- [Why Keploy?](https://keploy.io/docs/keploy-explained/why-keploy/): Comparison with traditional testing approaches
- [Supported Languages](https://keploy.io/docs/keploy-explained/supported-languages/): Unit-testing language support; Go supported, more languages coming soon

Expand Down Expand Up @@ -54,7 +56,7 @@ Keploy (founded 2021) is a CNCF Landscape project and open-source testing platfo
- [Production Sandbox Testing](https://keploy.io/docs/concepts/what-is-keploy/): Production-like environments without staging infrastructure

## Keploy Cloud & Integrations
- [Keploy Cloud](https://keploy.io/docs/keploy-cloud/cloud-installation/): Managed cloud platform for teams
- [Enterprise plan](https://keploy.io/docs/keploy-cloud/cloud-installation/): Getting started on the Enterprise plan — install Keploy, sign in, and the plan's features
- [VS Code Extension](https://keploy.io/docs/keploy-explained/integrations-vscode/): IDE integration for test generation
- [PR Agent Integration](https://keploy.io/docs/keploy-explained/integrations-pr-agent/): Automated test suggestions on pull requests

Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ fbq('track', 'PageView');`,
docsDir: `versioned_docs/version-${CURRENT_DOCS_VERSION}`,
ignoreFiles: ["**/shared/**"],
description:
"Technical documentation for Keploy, an open-source AI-powered testing agent and sandboxing platform that automatically generates test cases, dependency mocks, and production-like sandboxes from real user traffic using eBPF kernel technology. Keploy keeps testing aligned with AI-driven code velocity — achieving 90% test coverage in minutes with zero code changes.",
"Technical documentation for Keploy, an AI-powered testing agent and sandboxing platform that automatically generates test cases, dependency mocks, and production-like sandboxes from real user traffic, captured at the network layer (with eBPF on Linux, in user space on macOS and Windows). Keploy keeps testing aligned with AI-driven code velocity — achieving 90% test coverage in minutes with zero code changes.",
rootContent: llmsRootContent,
fullRootContent: llmsFullRootContent,
generateLLMsTxt: true,
Expand Down Expand Up @@ -175,7 +175,7 @@ fbq('track', 'PageView');`,
{
name: "description",
content:
"Keploy - Open source tool that generates Regression Tests like unit tests with mocks and stubs from API calls.",
"Keploy - Tool that generates Regression Tests like unit tests with mocks and stubs from API calls.",
},
{
name: "keywords",
Expand Down
4 changes: 2 additions & 2 deletions src/components/Community.js
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,12 @@ export const Community = () => {
))}
</div>

{/* Enterprise Demo CTA */}
{/* Demo CTA */}
<div className="rounded-2xl border border-gray-200 bg-gradient-to-r from-gray-50 to-gray-100 p-6 dark:border-gray-700 dark:from-gray-800/80 dark:to-gray-900/80">
<div className="flex flex-col items-center justify-between gap-5 md:flex-row">
<div className="text-center md:text-left">
<h3 className="mb-1 text-lg font-bold text-gray-900 dark:text-white">
Want to see a demo of Keploy Enterprise?
Want to see a demo of Keploy?
</h3>
<p className="text-sm text-gray-600 dark:text-gray-400">
Share your use-case, workflow—and we'll help with any resources
Expand Down
8 changes: 4 additions & 4 deletions src/components/EnterpriseInstallReminder.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ export default function EnterpriseInstallReminder() {
return (
<div style={containerStyle}>
<h3 style={{marginTop: 0, color: isDark ? "#fff" : "#222"}}>
Don’t have Keploy Enterprise installed yet?
Don’t have Keploy installed yet?
</h3>
<p style={{color: isDark ? "#ccc" : undefined}}>
Before running this sample, make sure Keploy Enterprise version is
installed on your system.
Before running this sample, make sure Keploy is installed on your system
and you’re signed in to your Keploy account (<code>keploy login</code>).
</p>
<Link
to="/docs/keploy-cloud/cloud-installation/"
to="/docs/server/installation/"
style={{
display: "inline-block",
marginTop: "0.5rem",
Expand Down
65 changes: 45 additions & 20 deletions src/components/ProductTier.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,59 @@ import React from "react";
* ProductTier - Compact inline chips for doc metadata
* Replaces the old large "Tier/Offering" card with small inline chips
*
* Usage:
* <ProductTier tiers="Open Source" />
* <ProductTier tiers="Open Source, Enterprise" offerings="Self-Hosted" />
* Usage (tiers are Keploy plans):
* <ProductTier tiers="Free, Teams, Scale, Enterprise" offerings="Self-Hosted, Dedicated" />
* <ProductTier tiers="Scale, Enterprise" />
* <ProductTier tiers="Enterprise" />
*/

const freeChip = {
label: "Free",
color: "#059669",
bg: "rgba(16, 185, 129, 0.1)",
};

const chipStyles = {
// Tier chips
'open source': { label: 'OSS', color: '#059669', bg: 'rgba(16, 185, 129, 0.1)' },
'oss': { label: 'OSS', color: '#059669', bg: 'rgba(16, 185, 129, 0.1)' },
'enterprise': { label: 'Enterprise', color: '#7c3aed', bg: 'rgba(139, 92, 246, 0.1)' },
'cloud': { label: 'Cloud', color: '#2563eb', bg: 'rgba(59, 130, 246, 0.1)' },
// Plan chips
free: freeChip,
teams: {label: "Teams", color: "#0891b2", bg: "rgba(6, 182, 212, 0.1)"},
scale: {label: "Scale", color: "#4f46e5", bg: "rgba(99, 102, 241, 0.1)"},
enterprise: {
label: "Enterprise",
color: "#7c3aed",
bg: "rgba(139, 92, 246, 0.1)",
},
// Legacy tier names still render as the Free plan chip
"open source": freeChip,
oss: freeChip,
cloud: {label: "Cloud", color: "#2563eb", bg: "rgba(59, 130, 246, 0.1)"},

// Offering chips - simplified labels
'self-hosted': { label: 'Self-Hosted', color: '#6b7280', bg: 'rgba(107, 114, 128, 0.08)' },
'dedicated': { label: 'Dedicated', color: '#6b7280', bg: 'rgba(107, 114, 128, 0.08)' },
'local': { label: 'Local', color: '#6b7280', bg: 'rgba(107, 114, 128, 0.08)' },
"self-hosted": {
label: "Self-Hosted",
color: "#6b7280",
bg: "rgba(107, 114, 128, 0.08)",
},
dedicated: {
label: "Dedicated",
color: "#6b7280",
bg: "rgba(107, 114, 128, 0.08)",
},
local: {label: "Local", color: "#6b7280", bg: "rgba(107, 114, 128, 0.08)"},
};

const ProductTier = ({ tiers, offerings }) => {
const ProductTier = ({tiers, offerings}) => {
// Parse tiers and offerings into arrays
const tierList = tiers
? (Array.isArray(tiers) ? tiers : tiers.split(',').map(t => t.trim()))
? Array.isArray(tiers)
? tiers
: tiers.split(",").map((t) => t.trim())
: [];

// Skip offerings that are confusing for OSS (like "Self-Hosted, Dedicated")
// Only show offerings if explicitly needed
const offeringList = offerings && !tierList.some(t => t.toLowerCase().includes('open source'))
? (Array.isArray(offerings) ? offerings : offerings.split(',').map(o => o.trim()))
const offeringList = offerings
? Array.isArray(offerings)
? offerings
: offerings.split(",").map((o) => o.trim())
: [];

const allChips = [...tierList, ...offeringList];
Expand All @@ -44,14 +69,14 @@ const ProductTier = ({ tiers, offerings }) => {
const key = chip.toLowerCase().trim();
const style = chipStyles[key] || {
label: chip.trim(),
color: '#6b7280',
bg: 'rgba(107, 114, 128, 0.08)'
color: "#6b7280",
bg: "rgba(107, 114, 128, 0.08)",
};
return (
<span
key={index}
className="product-tier-chip"
style={{ color: style.color, background: style.bg }}
style={{color: style.color, background: style.bg}}
>
{style.label}
</span>
Expand Down
6 changes: 3 additions & 3 deletions src/components/QuickStartList.js
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ const quickstarts = [
server: "Docker",
description:
"A sample URL Shortener app to demonstrate Keploy integration capabilities using Mux and MySQL.",
link: "/docs/quickstart/samples-mysql/#using-docker-compose-",
link: "/docs/quickstart/samples-mysql/#using-docker-",
},
{
title: "Mux + Mysql",
Expand All @@ -156,7 +156,7 @@ const quickstarts = [
server: "Docker",
description:
"A sample CRUD application to demonstrate how seamlessly Keploy integrates with FastHttp and Postgres.",
link: "/docs/quickstart/samples-fasthttp/#using-docker-compose-",
link: "/docs/quickstart/samples-fasthttp/",
},
*/

Expand Down Expand Up @@ -234,7 +234,7 @@ const quickstarts = [
language: "Python",
server: "Docker",
description: "A Python Flask app connected to MongoDB running locally.",
link: "/docs/quickstart/samples-flask/#using-docker-compose",
link: "/docs/quickstart/samples-flask/#how-to-run-the-sample-application-using-docker-compose-",
},
{
title: "Flask + MongoDB",
Expand Down
18 changes: 10 additions & 8 deletions src/components/QuickStartTabs.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React, { useState } from "react";
import React, {useState} from "react";
import Link from "@docusaurus/Link";
import useBaseUrl from "@docusaurus/useBaseUrl";
import {
Expand Down Expand Up @@ -47,8 +47,8 @@ export const QuickStartTabs = () => {
primary: true,
},
},
oss: {
id: "oss",
record: {
id: "record",
label: "Record/Replay Quickstart",
time: "10 min",
icon: FaVideo,
Expand All @@ -72,14 +72,13 @@ export const QuickStartTabs = () => {
},
],
cta: {
label: "Start OSS Quickstart",
label: "Start Record/Replay Quickstart",
link: "/docs/quickstart/quickstart-filter/",
primary: false,
},
},
};


return (
<section className="mb-12">
{/* Section Header */}
Expand Down Expand Up @@ -145,7 +144,7 @@ export const QuickStartTabs = () => {
{/* Steps */}
<div className="mb-6 space-y-3">
{tab.steps.map((step, index) => {
return (
return (
<div key={index} className="flex items-start gap-3">
<div className="flex h-6 w-6 flex-shrink-0 items-center justify-center">
<span
Expand Down Expand Up @@ -173,7 +172,11 @@ export const QuickStartTabs = () => {

{/* CTA Button */}
<Link
to={tab.cta.link.startsWith("http") ? tab.cta.link : useBaseUrl(tab.cta.link)}
to={
tab.cta.link.startsWith("http")
? tab.cta.link
: useBaseUrl(tab.cta.link)
}
onClick={(e) => e.stopPropagation()}
className={`inline-flex w-full items-center justify-center gap-2 rounded-xl px-5 py-2.5 text-sm font-semibold transition-all duration-200 hover:no-underline ${
tab.id === "ai"
Expand Down Expand Up @@ -203,4 +206,3 @@ export const QuickStartTabs = () => {
};

export default QuickStartTabs;

2 changes: 1 addition & 1 deletion src/components/SDKs.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export const SDKs = () => {
<section className="my-20">
<h1 className="mb-2 text-3xl md:text-4xl">Supported OS</h1>
<p className="mb-8">
Find eBPF tutorials and dependency mock references in the language of
Find Keploy tutorials and dependency mock references in the language of
your choice.
</p>
<div className="grid grid-cols-1 gap-6 md:grid-cols-3 lg:gap-8">
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export default function Home() {
const docsHomeTitle =
"Keploy Documentation — Install, Capture & Replay API Tests";
const docsHomeDescription =
"Install Keploy in 5 minutes, capture real API traffic with eBPF, and replay it as deterministic tests in CI. Quickstarts, SDK references, and integration guides.";
"Install Keploy in 5 minutes, capture real API traffic, and replay it as deterministic tests in CI. Quickstarts, SDK references, and integration guides.";
// CollectionPage, not Article: this page is an index of the docs, with no
// single author, publication date or headline. DocItem already suppresses
// Article on /docs/ for exactly that reason, so emitting one here left the
Expand Down
9 changes: 4 additions & 5 deletions src/schema/siteEntities.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,21 +99,20 @@ const softwareApplicationNode = {
"@id": SOFTWARE_APPLICATION_ID,
name: "Keploy",
description:
"Keploy is an open-source, AI-powered testing agent and sandboxing platform that automatically generates test cases, dependency mocks, and production-like sandboxes from real user traffic using eBPF. It helps developers achieve 90% test coverage in minutes with zero code changes. Native support is available on Linux; macOS and Windows require a Linux environment such as Lima, WSL, or Docker.",
"Keploy is an AI-powered testing agent and sandboxing platform that automatically generates test cases, dependency mocks, and production-like sandboxes from real user traffic, captured at the network layer. It helps developers achieve 90% test coverage in minutes with zero code changes. It runs natively on Linux (using eBPF), on macOS with Apple Silicon and on x86-64 Windows (in user space, with no VM or Docker).",
applicationCategory: "DeveloperTool",
applicationSubCategory: "Test Automation",
operatingSystem: "Linux",
license: "https://www.apache.org/licenses/LICENSE-2.0",
operatingSystem: "Linux, macOS, Windows",
softwareHelp: DOCS_URL,
codeRepository: "https://github.com/keploy/keploy",
downloadUrl: "https://github.com/keploy/keploy/releases",
downloadUrl: `${DOCS_URL}server/installation/`,
isAccessibleForFree: true,
url: SITE_URL,
featureList: [
"Automatic test case generation from real user traffic",
"Production-like sandbox environments from captured traffic",
"AI-powered dependency virtualization and mock generation",
"Record and replay testing with eBPF kernel capture",
"Record and replay testing with network-layer traffic capture (eBPF on Linux, user space on macOS and Windows)",
"AI noise detection for flaky test elimination",
"Legacy application testing without code changes",
"Migration regression testing against production baselines",
Expand Down
Loading
Loading