@membranehq/cli 0.7.0 → 0.9.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 +15 -0
- package/dist/index.js +98 -98
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -34,6 +34,19 @@ membrane --version
|
|
|
34
34
|
```
|
|
35
35
|
|
|
36
36
|
## Configuration
|
|
37
|
+
|
|
38
|
+
The CLI can be configured using either environment variables or a configuration file (`membrane.config.yml`). Environment variables take precedence over the configuration file.
|
|
39
|
+
|
|
40
|
+
### Environment Variables
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
export MEMBRANE_WORKSPACE_KEY=<your-workspace-key>
|
|
44
|
+
export MEMBRANE_WORKSPACE_SECRET=<your-workspace-secret>
|
|
45
|
+
export MEMBRANE_API_URI=https://api.integration.app # Optional: for self-hosted instances
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Configuration File
|
|
49
|
+
|
|
37
50
|
The CLI uses a configuration file at `membrane.config.yml`:
|
|
38
51
|
|
|
39
52
|
```yaml
|
|
@@ -43,6 +56,8 @@ apiUri: https://api.integration.app # Set it to work with a self-hosted version
|
|
|
43
56
|
testCustomerId: test-customer # Internal id of the customer to be used for testing integrations.
|
|
44
57
|
```
|
|
45
58
|
|
|
59
|
+
**Note:** When both environment variables and configuration file are present, environment variables take precedence.
|
|
60
|
+
|
|
46
61
|
## Version Control
|
|
47
62
|
|
|
48
63
|
`membrane.config.yml` contains secrets. You should exclude it from version control.
|