envis-node 0.0.1 → 0.0.3
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 +56 -0
- package/package.json +5 -1
- package/src/session.js +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# envis-node
|
|
2
|
+
|
|
3
|
+
-----
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
- [Overview](#overview)
|
|
8
|
+
- [Installation](#installation)
|
|
9
|
+
- [Usage](#usage)
|
|
10
|
+
- [License](#license)
|
|
11
|
+
- [Contact](#contact)
|
|
12
|
+
|
|
13
|
+
## Overview
|
|
14
|
+
Envisible is a simple, secure secret management platform. The SDK allows users to integrate their secrets (configured [on our web dashboard](https://envisible.netlify.app)) directly into their Node.js code.
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
```console
|
|
19
|
+
cd node-sdk
|
|
20
|
+
npm install
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
1. Sign up for an Envisible account on the dashboard.
|
|
26
|
+
2. Install the SDK and authenticate when prompted (the SDK will open a secure browser window).
|
|
27
|
+
3. Read and manage secrets from any Node.js runtime:
|
|
28
|
+
|
|
29
|
+
### Fetching a secret
|
|
30
|
+
|
|
31
|
+
```javascript
|
|
32
|
+
const envis = require("envis-node");
|
|
33
|
+
|
|
34
|
+
async function main() {
|
|
35
|
+
const secret = await envis.get("project_id", "secret_name");
|
|
36
|
+
console.log(secret);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
main();
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Logging out
|
|
43
|
+
|
|
44
|
+
```javascript
|
|
45
|
+
const envis = require("envis-node");
|
|
46
|
+
|
|
47
|
+
envis.logout();
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
`envis-node` is released under a private source-available license: you can use the SDK to integrate with [our web dashboard](https://envisible.netlify.app), but the backend platform remains proprietary.
|
|
53
|
+
|
|
54
|
+
## Contact
|
|
55
|
+
- [Website](https://envisible.netlify.app)
|
|
56
|
+
- [Email](mailto:contact@uarham.me)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "envis-node",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"description": "Secure, simple secret management",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"secret",
|
|
@@ -10,6 +10,10 @@
|
|
|
10
10
|
],
|
|
11
11
|
"license": "ISC",
|
|
12
12
|
"author": "Umair Arham",
|
|
13
|
+
"repository": {
|
|
14
|
+
"type": "git",
|
|
15
|
+
"url": "https://github.com/umairx25/Envisible-Clients"
|
|
16
|
+
},
|
|
13
17
|
"type": "commonjs",
|
|
14
18
|
"main": "src/index.js",
|
|
15
19
|
"scripts": {
|