Shiplight AI Quickstart Guide

View as Markdown

LEGACY — Shiplight Cloud v1

This page documents Shiplight Cloud v1 (app.shiplight.ai), which is no longer the current product. For the current cloud platform, see Shiplight Cloud.

⚠️ Account Required: This guide assumes you have a valid Shiplight AI account. Contact info@shiplight.ai for creating an account.

This guide provides a quick overview of creating your first test case with Shiplight AI. For more detailed information, check out the individual guides linked on this page.

Table of Contents

1. Logging In
2. Setting Up Your Environment
3. Creating Your First Test Case
4. Working with the Test Editor

1. Logging In

Sign in to Shiplight AI using your credentials:

• Use your email and password
• Or Continue with Google (domain must match your organization)

If you don't have an account, contact info@shiplight.ai.

2. Setting Up Your Environment

Before creating tests, configure your testing environment. Navigate to Settings in the left sidebar.

Configure Environment

1. Add Environment:
   • Name: Give your environment a descriptive name (e.g., "Production", "Staging")
   • Base URL: Enter the domain URL (e.g., https://app.example.com)

Configure Test Accounts (Optional)

If your application requires authentication:

1. Add Test Account:
   • Select the environment for this account
   • Enter credentials (username/password)
   • For OAuth authentication:
     • Check "OAuth Authentication"
     • Select the OAuth provider (Google, GitHub, etc.)

3. Creating Your First Test Case

Click the Create Test button in the top right of the Tests page to open the creation modal. For detailed information, see Creating a Test.

Basic Configuration

1. Test Title:

   • Defaults to "Test Case - [Current Date]"
   • Enter a descriptive name for your test

2. Starting URL:

   • Select your environment from the dropdown
   • Enter the URL path (e.g., /login, /dashboard)
   • The full URL will be constructed automatically

3. Test Account Selection:

   • None: No authentication required
   • Random: Use any available test account
   • Specific: Select specific test accounts

Test Creation Modes

• Single Test Creation: Create one test case at a time
• Batch Test Creation: Generate multiple related test cases

For this quickstart, we'll use Single Test Creation.

Goal Field:

• Enter a natural language description of what you want to test
• Example: "Verify user can add items to cart and proceed to checkout"
• Leave blank to manually create test steps

4. Working with the Test Editor

Once your test is created, you'll be taken to the test editor. For comprehensive details, see the Test Editor documentation.

Test Editor

The modern test editor allows you to:

• Create complex test flows with visual editing
• Add conditional logic and loops
• Use variables for dynamic testing - See variables guide
• Organize steps hierarchically
• Leverage AI features for intelligent test creation - Learn about AI features

Adding Test Steps

1. Click the + button or Add Step to create a new step
2. Enter natural language instructions for the AI to execute
3. Supported step types:
   • Actions: Click, type, navigate - Learn more
   • Assertions: Verify page content, element presence
   • Flow Control: Conditions, loops, waits

Interactive Debugging

Debug Mode provides powerful testing capabilities - Learn debugging techniques:

• Start: Launch the browser and pause before the first step
• Step: Execute one step at a time
• Run: Execute all remaining steps
• Live View: See the browser in real-time
• Console: View logs and debug information

Managing Your Test

• Save: Save your current test configuration
• Revert: Reset to the last saved version
• Run Test: Execute the test and view results
• Schedule: Add to a test plan for regular execution

Advanced Features

• Setup/Teardown: Configure test prerequisites
• Variables: Use dynamic data in your tests - Learn about variables
• Functions: Create reusable test logic - Learn about functions
• Test Configurations: Run tests across different environments - Learn more

Next Steps

• Creating Test Suites - Group related tests together
• Scheduling Test Runs - Schedule automated test runs
• Navigating Results - Understand test execution results
• CI/CD Integration - Integrate with your deployment pipeline