flurry-cli 0.0.4 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -34
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
<img src="https://flurrytest.com/flurrylogo.jpg" alt="Flurry logo" width="150"/><br/>
|
|
4
2
|
|
|
5
3
|
A command-line interface for running Flurry API testing collections.
|
|
6
4
|
|
|
@@ -21,38 +19,24 @@ A command-line interface for running Flurry API testing collections.
|
|
|
21
19
|
|
|
22
20
|
### Run entire collection
|
|
23
21
|
```bash
|
|
24
|
-
npx flurry-cli --collection-id
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
### Run entire collection (with explicit environment)
|
|
28
|
-
```bash
|
|
29
|
-
npx flurry-cli --collection-id=abc123 --api-key=your-api-key --environment=development
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
### Run specific flow with verbose output
|
|
33
|
-
```bash
|
|
34
|
-
npx flurry-cli --collection-id=abc123 --api-key=your-api-key --environment=staging --run-flow-id=flow456 --verbose=true
|
|
22
|
+
npx flurry-cli@latest --collection-id=<COLLECTION_ID> --api-key=your-api-key --environment=staging
|
|
35
23
|
```
|
|
36
24
|
|
|
37
|
-
### Run
|
|
25
|
+
### Run specific flow
|
|
38
26
|
```bash
|
|
39
|
-
npx flurry-cli --collection-id
|
|
27
|
+
npx flurry-cli@latest --collection-id=<COLLECTION_ID> --api-key=your-api-key --environment=staging --run-flow-id=flow456
|
|
40
28
|
```
|
|
41
29
|
|
|
42
30
|
## AWS Credentials
|
|
43
31
|
|
|
44
|
-
Flurry uses the AWS SDK for JavaScript (v3) to talk to AWS.
|
|
45
|
-
|
|
46
|
-
In particular, some AWS CLI authentication flows cache credentials in a way the JS SDK cannot read directly (your case showed `access_key` type `login` via `aws configure list`). When that happens, Flurry falls back to asking the AWS CLI to export concrete credentials.
|
|
47
|
-
|
|
48
|
-
### Resolution Order
|
|
32
|
+
Flurry uses the AWS SDK for JavaScript (v3) to talk to AWS.
|
|
49
33
|
|
|
50
|
-
Flurry resolves credentials in this order:
|
|
34
|
+
Flurry resolves AWS credentials in this order:
|
|
51
35
|
|
|
52
|
-
1. **Environment credentials
|
|
36
|
+
1. **Environment credentials**: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, optional `AWS_SESSION_TOKEN`
|
|
53
37
|
2. **Shared config/credentials files**: `~/.aws/credentials` and `~/.aws/config` using `AWS_PROFILE` / `AWS_DEFAULT_PROFILE`
|
|
54
38
|
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`)
|
|
55
|
-
4. **Default AWS SDK provider chain** as a final fallback
|
|
39
|
+
4. **Default AWS SDK provider chain** as a final fallback.
|
|
56
40
|
|
|
57
41
|
### GitHub Actions / CI
|
|
58
42
|
|
|
@@ -61,7 +45,8 @@ In GitHub Actions you typically should **not** rely on AWS profiles. Prefer one
|
|
|
61
45
|
- **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.
|
|
62
46
|
- **Static secrets**: set `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and optionally `AWS_SESSION_TOKEN`.
|
|
63
47
|
|
|
64
|
-
If you
|
|
48
|
+
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
|
|
49
|
+
`FLURRY_ENABLE_AWS_CLI_CREDENTIALS` to 1, and `AWS_PROFILE` to the profile used when loggin in.
|
|
65
50
|
|
|
66
51
|
## Environment Variables
|
|
67
52
|
|
|
@@ -102,12 +87,4 @@ Region:
|
|
|
102
87
|
|
|
103
88
|
- `AWS_REGION` / `AWS_DEFAULT_REGION`
|
|
104
89
|
- Used by the AWS SDK clients (SQS/Kinesis) and for some auth flows.
|
|
105
|
-
- If not set, Flurry falls back to `us-east-1`.
|
|
106
|
-
|
|
107
|
-
Web identity (OIDC) / role assumption (common in CI):
|
|
108
|
-
|
|
109
|
-
- `AWS_ROLE_ARN`, `AWS_WEB_IDENTITY_TOKEN_FILE`
|
|
110
|
-
- Used for GitHub Actions OIDC / IRSA-style auth.
|
|
111
|
-
|
|
112
|
-
- `AWS_ROLE_SESSION_NAME`
|
|
113
|
-
- Optional session name for assumed roles.
|
|
90
|
+
- If not set, Flurry falls back to `us-east-1`.
|