Back to Home

Documentation

Everything you need to get started with Conduii

Getting Started

Quick start guide to set up Conduii

CLI Reference

Complete CLI command documentation

API Reference

REST API documentation

Integrations

Connect your services

Getting Started

Installation

1. Install the CLI

Install the Conduii CLI globally using npm, yarn, or pnpm:

npm install -g @conduii/cli

Or with yarn:

yarn global add @conduii/cli

2. Authenticate

Log in to your Conduii account to connect the CLI:

conduii login

3. Verify installation

Check that everything is working:

conduii --version
Getting Started

Configuration

Conduii can be configured using a conduii.config.js file in your project root:

// conduii.config.js
module.exports = {
  // Project configuration
  project: {
    name: 'My Project',
    environment: 'production',
  },

  // Service discovery options
  discovery: {
    exclude: ['node_modules', '.git', 'dist'],
  },

  // Test configuration
  tests: {
    timeout: 30000,
    retries: 2,
    parallel: true,
  },
};
Getting Started

First Test Run

1. Discover your project

Run discovery to automatically detect your services:

conduii discover

# Output:
# ✓ Found Next.js project
# ✓ Detected: Vercel, Supabase, Stripe
# ✓ Generated 24 tests

2. Run tests

Execute the discovered tests:

conduii run

# Output:
# Running 24 tests...
# ✓ All 24 tests passed in 12.4s
CLI Reference

conduii discover

Automatically discover services and integrations in your project.

conduii discover [options]

Options:
  -p, --path <path>    Path to project (default: current directory)
  -e, --env <file>     Environment file to use (default: .env)
  --no-cache          Disable caching
  -v, --verbose       Verbose output
CLI Reference

conduii run

Execute tests against your deployed infrastructure.

conduii run [options]

Options:
  -t, --type <type>    Test type: all, health, integration, api, e2e
  -e, --env <name>     Environment to test (staging, production)
  --suite <id>        Run specific test suite
  --parallel          Run tests in parallel
CLI Reference

conduii status

Check the status of services and test runs.

conduii status [options]

Options:
  --last              Show last test run results
  --services          Show service health status
  --watch             Watch for updates
API Reference

Authentication

All API requests require authentication using an API key.

curl -X GET "https://api.conduii.com/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY"
API Reference

Projects API

List Projects

GET /v1/projects

Create Project

POST /v1/projects
{ "name": "My Project", "productionUrl": "https://myapp.com" }
API Reference

Test Runs API

Start Test Run

POST /v1/projects/:projectId/runs
{ "testType": "all", "environment": "production" }

Get Test Run Status

GET /v1/test-runs/:runId
Integrations

GitHub Actions

Run Conduii tests as part of your CI/CD pipeline.

# .github/workflows/test.yml
name: Deployment Tests
on:
  deployment_status:
    states: [success]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: ehudso7/conduii-action@v1
        with:
          api-key: ${{ secrets.CONDUII_API_KEY }}
          project-id: proj_123
Integrations

Vercel Integration

Conduii automatically detects and tests Vercel deployments.

  1. Add your Vercel token to your Conduii project settings
  2. Conduii will automatically discover your Vercel projects
  3. Tests run automatically after each deployment
Integrations

Webhooks

Receive notifications when test runs complete.

POST https://your-server.com/webhook
{
  "event": "test_run.completed",
  "testRun": {
    "id": "run_789",
    "status": "PASSED"
  }
}

Ready to get started?