diff --git a/docs.json b/docs.json index 4251c7217..da5f3b8f7 100644 --- a/docs.json +++ b/docs.json @@ -43,10 +43,11 @@ "tab": "Docs", "icon": "book-open-lines", "pages": [ + "docs/index", { "group": "Kane CLI", "pages": [ - "docs/index", + "docs/kane-cli-introduction", { "group": "Getting Started", "pages": [ diff --git a/docs/index.mdx b/docs/index.mdx index be427e75b..63f81be6a 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -1,63 +1,590 @@ --- -title: "Kane CLI" -sidebarTitle: "Introduction" -description: "Kane CLI is an AI-powered command-line tool that runs browser automation tests in plain English: from your terminal, IDE, or CI pipeline." -keywords: ['kane cli', 'kaneai', 'browser automation', 'testmu ai', 'ai cli', 'natural language testing'] -"og:description": "Kane CLI is an AI-powered command-line tool that runs browser automation tests in plain English: from your terminal, IDE, or CI pipeline." +mode: "custom" +title: "TestMu AI Documentation" +description: "Explore guides, API docs, and examples for TestMu AI (Formerly LambdaTest) - the AI-native quality engineering platform." slug: / --- -import AgentSkillCallout from "/snippets/AgentSkillCallout.mdx"; +
+
+
+
+

+ TestMu AI (Formerly LambdaTest) Documentation +

+

+ Build, run, and scale tests on TestMu AI, the AI-native quality engineering platform. Setup guides, API references, and tutorials in one place. +

+
+ +
+
+
+ TestMu AI +
+
+
+
---- +
+
+ +
+ +
+
+ +

Web Automation

+
+
+ + Selenium Testing + + + Cypress Testing + + + Playwright Testing + + + Puppeteer Testing + + + K6 Testing + +
+
+ +
+
+ +

App Automation

+
+
+ + Appium Testing + + + Espresso Testing + + + XCUI Testing + + + Flutter Testing + + + Virtual Devices + +
+
+ +
+
+ +

HyperExecute

+
+
+ + Getting Started + + + HyperExecute YAML + + + HyperExecute CLI + + + HyperExecute GUI BETA + + + HyperExecute MCP Server + + + Features + + + Integrations + + + Private Cloud + +
+
+ +
+
+ +

Insights

+
+
+ + Pre-built Dashboards + + + Custom Dashboards + + + Widgets + + + Dashboard CoPilot AI + + + Test Case Insights + + + Build Insights + + + Flaky Test Insights + + + Command Logs Insights + +
+
+ +
+
+ +

Browser Cloud

NEW +
+
+ + What is Browser Cloud + + + Launch Session With SDK + + + Launch Session With Agent Skills + + + Connect to a Session + +
+
+ +
+
+ +

SmartUI

+
+
+ + Getting Started + + + Explore SDKs + + + CLI + + + Upload Screenshots + + + Smart PDF Comparison + + + Build Config and Options + + + Advance Comparison Options + + + Handling Dynamic Data + +
+
- +
+
+ +

KaneAI

+
+ +
-**Kane CLI** `kane-cli` is an AI-powered browser automation tool that runs from your terminal. Describe what you want to test in plain English: Kane CLI navigates websites, clicks elements, fills forms, extracts data, and validates outcomes in a real Chrome browser. +
+
+ +

Kane CLI

NEW +
+ +
-- **Run browser tests from any terminal or IDE**: no test scripts, no selectors, no framework boilerplate -- **Integrate into CI/CD pipelines**: headless mode with structured JSON output and standard exit codes -- **Use as a skill in AI coding agents**: Claude Code, Codex CLI, and Gemini CLI can invoke Kane CLI directly to test and verify web UIs on your behalf +
+
+ +

Web Scanner

NEW +
+ +
-```bash -# Install -npm install -g @testmuai/kane-cli +
+
+ +

Agent Testing Platform

+
+ +
-# Authenticate -kane-cli login +
+
+ +

Real Time

+
+ +
-# Run your first test -kane-cli run --url https://example.com "Click the 'More information' link and verify the page loads" -``` +
+
+ +

Real Device

+
+ +
-## Supported IDEs +
+
+ +

Test Manager

NEW +
+ +
-Kane CLI runs from the integrated terminal of your editor, so you can drive browser tests without leaving your development environment. It is supported in: +
+
+ +

TestMu AI MCP Server

NEW +
+ +
-* Cursor -* Antigravity -* VS Code -* Codex -* Kiro (AWS) -* Eclipse-based IDEs -* Web-based IDEs +
+
+ +

Integrations

+
+ +
-## Three Modes +
+
+ +

Accessibility Testing

+
+ +
-| Mode | Command | Best For | -|------|---------|----------| -| **Interactive TUI** | `kane-cli --tui` | Development, exploration, chained multi-run sessions | -| **Non-Interactive CLI Mode** | `kane-cli run "..." --headless --agent` | CI/CD pipelines, shell scripts | -| **Agent Mode** | `kane-cli run "..." --agent` | AI coding agents (Claude, Codex, Gemini) | +
+
+ +

Testing Locally

+
+ +
-## Next Steps +
+
+ +

Settings and Security

+
+ +
-- [Installation](/docs/kane-cli-installation/): Install Kane CLI and verify your setup -- [Quick Start](/docs/kane-cli-quickstart/): Authenticate and run your first test in 5 minutes -- [Authentication](/docs/kane-cli-authentication/): OAuth, basic auth, and profile management -- [Writing Objectives](/docs/kane-cli-writing-objectives/): Learn how to write effective natural language objectives -- [Configuration](/docs/kane-cli-configuration/): Window size, Chrome profiles, Test Manager project, and run mode -- [Test Manager Integration](/docs/kane-cli-tms-integration/): Uploads, share links, code export, and session history -- [Agent Mode](/docs/kane-cli-agent-mode/): Use Kane CLI with AI coding agents -- [CI/CD Integration](/docs/kane-cli-cicd/): Add Kane CLI to your pipeline -- [Skills](/docs/kane-cli-skills/): Install the Kane CLI skill for Claude, Codex, or Gemini +
+
+ +

Other Docs

+
+ +
+
+
+
diff --git a/docs/kane-cli-introduction.mdx b/docs/kane-cli-introduction.mdx new file mode 100644 index 000000000..ec50e4c75 --- /dev/null +++ b/docs/kane-cli-introduction.mdx @@ -0,0 +1,62 @@ +--- +title: "Kane CLI" +sidebarTitle: "Introduction" +description: "Kane CLI is an AI-powered command-line tool that runs browser automation tests in plain English: from your terminal, IDE, or CI pipeline." +keywords: ['kane cli', 'kaneai', 'browser automation', 'testmu ai', 'ai cli', 'natural language testing'] +"og:description": "Kane CLI is an AI-powered command-line tool that runs browser automation tests in plain English: from your terminal, IDE, or CI pipeline." +--- + +import AgentSkillCallout from "/snippets/AgentSkillCallout.mdx"; + +--- + + + +**Kane CLI** `kane-cli` is an AI-powered browser automation tool that runs from your terminal. Describe what you want to test in plain English: Kane CLI navigates websites, clicks elements, fills forms, extracts data, and validates outcomes in a real Chrome browser. + +- **Run browser tests from any terminal or IDE**: no test scripts, no selectors, no framework boilerplate +- **Integrate into CI/CD pipelines**: headless mode with structured JSON output and standard exit codes +- **Use as a skill in AI coding agents**: Claude Code, Codex CLI, and Gemini CLI can invoke Kane CLI directly to test and verify web UIs on your behalf + +```bash +# Install +npm install -g @testmuai/kane-cli + +# Authenticate +kane-cli login + +# Run your first test +kane-cli run --url https://example.com "Click the 'More information' link and verify the page loads" +``` + +## Supported IDEs + +Kane CLI runs from the integrated terminal of your editor, so you can drive browser tests without leaving your development environment. It is supported in: + +* Cursor +* Antigravity +* VS Code +* Codex +* Kiro (AWS) +* Eclipse-based IDEs +* Web-based IDEs + +## Three Modes + +| Mode | Command | Best For | +|------|---------|----------| +| **Interactive TUI** | `kane-cli --tui` | Development, exploration, chained multi-run sessions | +| **Non-Interactive CLI Mode** | `kane-cli run "..." --headless --agent` | CI/CD pipelines, shell scripts | +| **Agent Mode** | `kane-cli run "..." --agent` | AI coding agents (Claude, Codex, Gemini) | + +## Next Steps + +- [Installation](/docs/kane-cli-installation/): Install Kane CLI and verify your setup +- [Quick Start](/docs/kane-cli-quickstart/): Authenticate and run your first test in 5 minutes +- [Authentication](/docs/kane-cli-authentication/): OAuth, basic auth, and profile management +- [Writing Objectives](/docs/kane-cli-writing-objectives/): Learn how to write effective natural language objectives +- [Configuration](/docs/kane-cli-configuration/): Window size, Chrome profiles, Test Manager project, and run mode +- [Test Manager Integration](/docs/kane-cli-tms-integration/): Uploads, share links, code export, and session history +- [Agent Mode](/docs/kane-cli-agent-mode/): Use Kane CLI with AI coding agents +- [CI/CD Integration](/docs/kane-cli-cicd/): Add Kane CLI to your pipeline +- [Skills](/docs/kane-cli-skills/): Install the Kane CLI skill for Claude, Codex, or Gemini