@clef-sh/cloud 0.1.18 → 0.1.19-beta.92
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 +46 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# @clef-sh/cloud
|
|
2
|
+
|
|
3
|
+
Clef Cloud integration for [Clef](https://clef.sh) — managed KMS, device-flow authentication, and artifact hosting. Ships as an optional plugin for the CLI and UI.
|
|
4
|
+
|
|
5
|
+
No secret data passes through Clef Cloud. The service manages encryption keys and serves packed artifacts — your plaintext never leaves your machine.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @clef-sh/cloud
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Features
|
|
14
|
+
|
|
15
|
+
- **Managed KMS**: Cloud-hosted age key management with `clef cloud init --env <environment>`
|
|
16
|
+
- **Device-flow auth**: Browser-based login via `clef cloud login`, tokens stored locally
|
|
17
|
+
- **Remote packing**: `clef pack --remote` sends encrypted files to Cloud for packing and serving
|
|
18
|
+
- **Artifact hosting**: `clef pack --push` uploads locally packed artifacts to Cloud for serving
|
|
19
|
+
- **Key service**: Lazy-loaded Go binary that speaks the SOPS gRPC protocol, proxying KMS operations through the Cloud API
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
Enable with the `CLEF_CLOUD` environment variable:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
export CLEF_CLOUD=1
|
|
27
|
+
clef cloud login
|
|
28
|
+
clef cloud init --env production
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Once configured, standard CLI commands (`clef set`, `clef get`, `clef pack`) use Cloud KMS automatically for environments configured with the cloud backend.
|
|
32
|
+
|
|
33
|
+
## Subpath exports
|
|
34
|
+
|
|
35
|
+
- `@clef-sh/cloud` — core client: auth, credentials, pack client, artifact client
|
|
36
|
+
- `@clef-sh/cloud/cli` — CLI command registration (used by `@clef-sh/cli`)
|
|
37
|
+
- `@clef-sh/cloud/ui` — UI components for Cloud status and billing
|
|
38
|
+
|
|
39
|
+
## Documentation
|
|
40
|
+
|
|
41
|
+
- [Clef Cloud guide](https://docs.clef.sh/guide/cloud)
|
|
42
|
+
- [API reference](https://docs.clef.sh/api/)
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
MIT
|