@cloak-db/app 0.1.2 → 0.2.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 +67 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/Cloak-DB/cloak-monolith/refs/heads/main/logo.png" alt="Cloak DB Logo" width="120">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">@cloak-db/app</h1>
|
|
6
|
+
|
|
7
|
+
<h4 align="center">Run Cloak DB locally with Docker</h4>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="https://www.npmjs.com/package/@cloak-db/app">
|
|
11
|
+
<img src="https://img.shields.io/npm/v/@cloak-db/app.svg" alt="npm version">
|
|
12
|
+
</a>
|
|
13
|
+
<a href="https://github.com/cloak-db/cloak-db/blob/main/LICENSE">
|
|
14
|
+
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
|
|
15
|
+
</a>
|
|
16
|
+
<a href="https://cloak-db.com">
|
|
17
|
+
<img src="https://img.shields.io/badge/website-cloak--db.com-blue" alt="Website">
|
|
18
|
+
</a>
|
|
19
|
+
</p>
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
[Cloak DB](https://cloak-db.com) is an open-source, local-first database studio built for development. It helps you iterate faster with features like database snapshots, resource inspection, and data anonymization.
|
|
24
|
+
|
|
25
|
+
## Requirements
|
|
26
|
+
|
|
27
|
+
- [Docker](https://docker.com) installed and running
|
|
28
|
+
|
|
29
|
+
## Usage
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npx @cloak-db/app
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
This pulls and runs the Cloak DB Docker image, making it available at [http://localhost:3000](http://localhost:3000).
|
|
36
|
+
|
|
37
|
+
## Options
|
|
38
|
+
|
|
39
|
+
| Flag | Description | Default |
|
|
40
|
+
|------|-------------|---------|
|
|
41
|
+
| `-p, --port <port>` | Port to run on | `3000` |
|
|
42
|
+
| `-v, --version <tag>` | Docker image version | `latest` |
|
|
43
|
+
| `-h, --help` | Show help | |
|
|
44
|
+
|
|
45
|
+
### Examples
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# Run on default port 3000
|
|
49
|
+
npx @cloak-db/app
|
|
50
|
+
|
|
51
|
+
# Run on custom port
|
|
52
|
+
npx @cloak-db/app --port 8080
|
|
53
|
+
|
|
54
|
+
# Run specific version
|
|
55
|
+
npx @cloak-db/app --version 0.1.2
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Links
|
|
59
|
+
|
|
60
|
+
- [Website](https://cloak-db.com)
|
|
61
|
+
- [Documentation](https://cloak-db.com/docs)
|
|
62
|
+
- [GitHub](https://github.com/cloak-db/cloak-db)
|
|
63
|
+
- [Report Issues](https://github.com/cloak-db/cloak-db/issues)
|
|
64
|
+
|
|
65
|
+
## License
|
|
66
|
+
|
|
67
|
+
MIT
|