rds-iam-auth 1.0.0 → 1.0.1
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 +21 -2
- package/package.json +7 -3
package/README.md
CHANGED
|
@@ -4,11 +4,31 @@ Generate AWS RDS IAM authentication tokens, usable both as a CLI and as a librar
|
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
|
+
### As a global CLI (from the registry)
|
|
8
|
+
|
|
9
|
+
The `-g` flag is required to use `rds-iam-auth` as a CLI command — without it, npm installs locally and won't put the command on your `PATH`.
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm i -g rds-iam-auth
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
This installs the `rds-iam-auth` command on your `PATH`, usable from any directory. Requires npm to be pointed at the registry this package is published to (`npm config get registry`), and that you're authenticated against it if it's a private registry.
|
|
16
|
+
|
|
17
|
+
### As a library dependency (from the registry)
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install rds-iam-auth
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Adds it to your project's `package.json` so you can `require('rds-iam-auth')` (see [Programmatic usage](#programmatic-usage) below). Same registry/authentication requirements as above.
|
|
24
|
+
|
|
25
|
+
### From source (local development)
|
|
26
|
+
|
|
7
27
|
```bash
|
|
8
28
|
npm install
|
|
9
29
|
```
|
|
10
30
|
|
|
11
|
-
To
|
|
31
|
+
To test changes as the global CLI without publishing:
|
|
12
32
|
|
|
13
33
|
```bash
|
|
14
34
|
npm i -g .
|
|
@@ -61,5 +81,4 @@ const token = await getRdsAuthToken({
|
|
|
61
81
|
|
|
62
82
|
## Notes
|
|
63
83
|
|
|
64
|
-
- This package is marked `"private": true` and is not set up for publishing to any registry.
|
|
65
84
|
- On Windows, if the globally installed CLI fails under Git Bash with a confusing error, try PowerShell or cmd.exe instead — this is an environment quirk unrelated to this package.
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rds-iam-auth",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "CLI to generate an IAM authentication token for AWS RDS",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
7
|
-
"rds-iam-auth": "
|
|
7
|
+
"rds-iam-auth": "bin/rds-iam-auth.js"
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
10
|
"bin",
|
|
@@ -12,7 +12,11 @@
|
|
|
12
12
|
"index.js"
|
|
13
13
|
],
|
|
14
14
|
"scripts": {
|
|
15
|
-
"start": "node bin/rds-iam-auth.js"
|
|
15
|
+
"start": "node bin/rds-iam-auth.js",
|
|
16
|
+
"test": "node --test"
|
|
17
|
+
},
|
|
18
|
+
"engines": {
|
|
19
|
+
"node": ">=18"
|
|
16
20
|
},
|
|
17
21
|
"dependencies": {
|
|
18
22
|
"@aws-sdk/rds-signer": "^3.1071.0"
|