Skip to main content

​
Table of Contents

​
Prerequisites

RequirementMinimum Version
Node.js20+
npm10+
IDECursor, VS Code, or MCP-compatible IDE
AccountAccess to Voidr platform
GitHubRequired for repository access

​
Initial Setup

​
1. Clone the Repository

git clone <repository-url> project-name
cd project-name

​
2. Install Dependencies

npm install
npm run install:browsers

​
3. Login to the Platform

npx voidr login
What happens:
  1. Browser opens automatically.
  2. Authenticate using Google.
  3. Select the correct organization.
  4. Terminal confirms success.
npx voidr link
This creates/updates project.json with:
  • orgId
  • applicationId
  • testPlanId

​
5. Configure MCP

npx voidr mcp-setup
After setup, the Voidr MCP server becomes available inside your IDE.

​
MCP Configuration

​
Supported IDEs

IDEConfig File
Cursor.cursor/mcp.json
VS CodeMCP extension config
OthersRefer to IDE documentation

​
Verifying MCP

Inside your IDE:
“List all test cases in the Voidr Test Plan.”
The AI will query the MCP server and return modules, suites, and test cases.

​
Workflow

Query → Create → Scaffold → Code → Build → Deploy

​
Query Tests

Example:
“List all test cases in the Test Plan.”

​
Create Tests via MCP

Example:
“Create module ‘Transactions’ with suite ‘Happy Path’ and test ‘Create transaction successfully’.”
The test appears as pending automation.

​
Scaffold Tests

npx voidr scaffold
Generates local .spec.js files. Example structure: 
modules/
└── transactions/
    ├── happyPath/
    │   └── happyPath.spec.js
    └── index.js

​
Automate Tests

import { test, expect } from '@/fixtures/actions'

test.describe('Happy Path', () => {
  test.skip('Create transaction successfully', async ({ page }) => {
    await expect(1).toBe(1)
  })
})
Remove skip after implementing logic.

​
Build Tests

npx voidr build
Compiles automated tests and prepares for upload.

​
Deploy Tests

npx voidr deploy-latest
Uploads compiled tests to the platform.

​
Quick Command Reference

CommandDescription
npx voidr loginAuthenticate
npx voidr linkLink to Test Plan
npx voidr mcp-setupConfigure MCP
npx voidr scaffoldGenerate test structure
npx voidr buildCompile tests
npx voidr deploy-latestDeploy tests
npx voidr statusCheck connection

​
Complete Flow Summary

1. npx voidr login
2. npx voidr link
3. npx voidr mcp-setup
4. Use MCP to manage tests
5. npx voidr scaffold
6. Implement tests
7. npx voidr build
8. npx voidr deploy-latest
9. Monitor execution at Voidr Platform