flurry-cli 0.0.3 → 0.0.5

package/LICENCE.md

@@ -19,30 +19,39 @@ This software includes the following third-party components. Each component is l
 ### 1. @aws-sdk/client-kinesis
 - **License**: Apache License, Version 2.0
 - **Copyright**: (c) 2025 Amazon.com, Inc. or its affiliates
-- **Details**: For the full license text, see the `LICENSE-APACHE` file included in this distribution or visit [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+- **Details**: For the full license text, see [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0).
 
 ### 2. @aws-sdk/client-sqs
 - **License**: Apache License, Version 2.0
 - **Copyright**: (c) 2025 Amazon.com, Inc. or its affiliates
-- **Details**: For the full license text, see the `LICENSE-APACHE` file included in this distribution or visit [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+- **Details**: For the full license text, see [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0).
 
-### 3. @aws-sdk/node-http-handler
+### 3. @aws-sdk/credential-providers
 - **License**: Apache License, Version 2.0
 - **Copyright**: (c) 2025 Amazon.com, Inc. or its affiliates
-- **Details**: For the full license text, see the `LICENSE-APACHE` file included in this distribution or visit [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+- **Details**: For the full license text, see [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0).
 
-### 4. chalk
+### 4. @aws-sdk/node-http-handler
+- **License**: Apache License, Version 2.0
+- **Copyright**: (c) 2025 Amazon.com, Inc. or its affiliates
+- **Details**: For the full license text, see [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+### 5. chalk
 - **License**: MIT License
 - **Copyright**: (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+- **Details**: For the full license text, see [https://opensource.org/license/mit/](https://opensource.org/license/mit/).
 
-### 5. lodash
+### 6. lodash
 - **License**: MIT License
 - **Copyright**: (c) JS Foundation and other contributors
+- **Details**: For the full license text, see [https://opensource.org/license/mit/](https://opensource.org/license/mit/).
 
-### 6. node-random-name
+### 7. node-random-name
 - **License**: MIT License
 - **Copyright**: (c) 2013-2016 Thomas McDonald
+- **Details**: For the full license text, see [https://opensource.org/license/mit/](https://opensource.org/license/mit/).
 
-### 7. zod
+### 8. zod
 - **License**: MIT License
 - **Copyright**: (c) 2020 Colin McDonnell
+- **Details**: For the full license text, see [https://opensource.org/license/mit/](https://opensource.org/license/mit/).

package/README.md

@@ -1,17 +1,15 @@
-# Flurry 
-
-![Flurry logo!](images/flurrylogo_small.jpg "Flurry logo")
+<img src="https://flurrytest.com/flurrylogo.jpg" alt="Flurry logo" width="150"/><br/>
 
 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  
-- `--environment` - The environment name to use
+- `--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
@@ -21,15 +19,72 @@ A command-line interface for running Flurry API testing collections.
 
 ### Run entire collection
 ```bash
-npx flurry-cli --collection-id=abc123 --api-key=your-api-key --environment=development
+npx flurry-cli@latest --collection-id=<COLLECTION_ID> --api-key=your-api-key --environment=staging 
 ```
 
-### Run specific flow with verbose output
+### Run specific flow
 ```bash
-npx flurry-cli --collection-id=abc123 --api-key=your-api-key --environment=staging --run-flow-id=flow456 --verbose=true
+npx flurry-cli@latest --collection-id=<COLLECTION_ID> --api-key=your-api-key --environment=staging --run-flow-id=flow456
 ```
 
-### Run collection without fail-fast (continue on assertion failures)
-```bash
-npx flurry-cli --collection-id=abc123 --api-key=your-api-key --environment=development --fail-fast=false
-```
+## 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`.