Documentation

To begin using Spyke, your first step is creating an organization. An organization acts as the top-level billing and administrative container for your team and all associated load tests.

1. Navigate to the Sign Up page.
2. Fill out your personal details (Name, Email, Password).
3. In the Organization Name field, provide a clear identifier for your company or team (e.g., "Acme Corp Engineering").
4. Click "Create Account". Your organization will be provisioned immediately with a starting allocation of 1,000 Free Virtual User hours (VUh).

Access your organization's resources through the secure login portal.

1. Go to the Login page.
2. Enter the email and password you used during registration.
3. Upon successful authentication, you will be redirected to your centralized Dashboard Overview, where you can view your Available Credit and recent test history.

Projects allow you to group related tests together and implement granular Role-Based Access Control (RBAC). Note: If you are a solo developer or do not require strict access isolation between teams, you can skip this step and run tests directly in your default workspace.

1. From your dashboard sidebar, click on Administration.
2. Navigate to the Projects tab.
3. Click the New Project button.
4. Provide a descriptive Project Name (e.g., "Mobile API Load Tests") and an optional description.
5. Click Create. You can now use the Project Dropdown in the top-right header to switch contexts and assign users specific roles (Editor/Viewer) exclusively to this project.

Spyke allows you to execute distributed load tests using your existing framework scripts. The orchestration engine automatically parses your requirements and spins up the necessary cloud infrastructure.

1. Click the prominent Create Test button at the top of your dashboard sidebar.
2. Test Name: Give your test a recognizable name (e.g., "Black Friday Checkout Flow").
3. Test Configuration:
   • Choose Global Load for a simplified setup, or Regional Load to explicitly distribute virtual users across different geographic data centers.
   • Define your target Virtual Users (VUs).
   • Set the Duration (in minutes) and Ramp-up Time.
4. Test Script: Select your preferred framework tab (JMeter, k6, Locust, Gatling, or Artillery) and upload your raw script file (e.g., `.jmx`, `.js`, `.py`).
5. Review the Estimated Cost in VUh at the bottom of the form to ensure it fits your available balance.
6. Click Launch Test. Spyke will provision the agents, distribute your script, and automatically transition you to the real-time telemetry dashboard.

To integrate Spyke directly into your Cursor IDE, configure a new MCP server in the settings panel:

1. Open Cursor Settings.
2. Navigate to Features > MCP.
3. Click + Add New MCP Server.
4. Name: Spyke
5. Type: command
6. Command: npx -y @spyke.cloud/mcp-server
7. Environment Variables: Add SPYKE_API_KEY with your generated key.