Skip to main content

Usage

Subcommands


generate

Generate a CI/CD pipeline configuration file for your project.

Flags

Supported Providers

Examples

GitHub Actions (default)

Generates .github/workflows/dokrypt.yml with test job.

GitHub Actions with deploy

Adds a deploy-testnet job that runs after tests pass on the main branch.

GitLab CI

Generates .gitlab-ci.yml with Docker-in-Docker service.

Custom output directory

Generated Pipeline Steps

Every generated workflow includes:
  1. Install Dokrypt via npm
  2. Run dokrypt doctor to verify prerequisites
  3. Start environment with dokrypt up --detach --fresh
  4. Wait for services with dokrypt status --wait --timeout 60s
  5. Run tests with dokrypt test run --json
  6. Upload results as build artifact
  7. Clean up with dokrypt down --volumes (runs even on failure)

Config Integration

If your project has a dokrypt.yaml with test settings, the generated workflow respects them:
The generated workflow will include --gas-report --coverage flags automatically.

validate

Check that an existing CI workflow file contains the required Dokrypt steps.

What It Checks

Example Output