A command-line interface for running Flurry API testing collections.

Required Options

• --collection-id - The collection ID to run
• --api-key - Your API key for authentication (required unless FLURRY_API_KEY is set)

Optional Options

• --environment - The environment name to use. If omitted, the CLI runs with a temporary empty environment.
• --run-flow-id - Run a single flow by ID (runs entire collection if not specified)
• --verbose - Set to true for detailed output (default: false)
• --fail-fast - Stop immediately on first assertion failure (default: true). Set to false to continue running all tests
• --help, -h - Show help message and exit

Examples

Run entire collection

npx flurry-cli@latest --collection-id=<COLLECTION_ID> --api-key=your-api-key --environment=staging 

Run specific flow

npx flurry-cli@latest --collection-id=<COLLECTION_ID> --api-key=your-api-key --environment=staging --run-flow-id=flow456

AWS Credentials

Flurry uses the AWS SDK for JavaScript (v3) to talk to AWS.

Flurry resolves AWS credentials in this order:

1. Environment credentials: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, optional AWS_SESSION_TOKEN
2. Shared config/credentials files: ~/.aws/credentials and ~/.aws/config using AWS_PROFILE / AWS_DEFAULT_PROFILE
3. AWS CLI fallback (for AWS CLI “login” caches): runs aws configure export-credentials --profile <profile> --format process (only if FLURRY_ENABLE_AWS_CLI_CREDENTIALS=true)
4. Default AWS SDK provider chain as a final fallback.

GitHub Actions / CI

In GitHub Actions you typically should not rely on AWS profiles. Prefer one of:

• OIDC / Web Identity (recommended): use aws-actions/configure-aws-credentials to set AWS_ROLE_ARN + AWS_WEB_IDENTITY_TOKEN_FILE (and region). The AWS SDK picks these up without needing profiles.
• Static secrets: set AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and optionally AWS_SESSION_TOKEN.

If you want to use AWS credentials obtained through logging in with the AWS CLI, ensure the runner has access to the appropriate ~/.aws/config, set FLURRY_ENABLE_AWS_CLI_CREDENTIALS to 1, and AWS_PROFILE to the profile used when loggin in.

Environment Variables

Flurry

• FLURRY_API_KEY

  • Alternative to passing --api-key.

• FLURRY_ENABLE_AWS_CLI_CREDENTIALS

  • When set to true, Flurry may use the AWS CLI fallback (aws configure export-credentials ...) if normal SDK credential resolution fails.
  • Default is disabled to avoid unexpected subprocess execution in CI/locked-down environments.

AWS (standard)

Credentials selection:

• AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN

  • Direct credentials. Highest priority. Recommended for CI.

• AWS_PROFILE / AWS_DEFAULT_PROFILE

  • Selects a named profile in your AWS config/credentials files.

Files:

• AWS_SHARED_CREDENTIALS_FILE

  • Overrides the default ~/.aws/credentials path.

• AWS_CONFIG_FILE

  • Overrides the default ~/.aws/config path.

Config loading:

• AWS_SDK_LOAD_CONFIG
  • When set to 1, the AWS SDK reads ~/.aws/config (needed for many config-driven profiles).
  • Flurry sets this automatically to 1 when AWS_PROFILE is set.

Region:

• AWS_REGION / AWS_DEFAULT_REGION
  • Used by the AWS SDK clients (SQS/Kinesis) and for some auth flows.
  • If not set, Flurry falls back to us-east-1.