@cloak-db/app 0.1.1 → 0.1.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/LICENSE +21 -0
- package/README.md +67 -0
- package/package.json +7 -8
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Cloak DB
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/cloak-db/cloak-db/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
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cloak-db/app",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "Run Cloak DB locally with Docker",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -9,12 +9,6 @@
|
|
|
9
9
|
"files": [
|
|
10
10
|
"dist"
|
|
11
11
|
],
|
|
12
|
-
"scripts": {
|
|
13
|
-
"build": "tsup src/cli.ts --format esm --dts",
|
|
14
|
-
"dev": "tsup src/cli.ts --format esm --watch",
|
|
15
|
-
"typecheck": "tsc --noEmit",
|
|
16
|
-
"prepublishOnly": "pnpm build"
|
|
17
|
-
},
|
|
18
12
|
"keywords": [
|
|
19
13
|
"cloak-db",
|
|
20
14
|
"database",
|
|
@@ -37,5 +31,10 @@
|
|
|
37
31
|
"@types/node": "^22.0.0",
|
|
38
32
|
"tsup": "^8.0.0",
|
|
39
33
|
"typescript": "^5.9.2"
|
|
34
|
+
},
|
|
35
|
+
"scripts": {
|
|
36
|
+
"build": "tsup src/cli.ts --format esm --dts",
|
|
37
|
+
"dev": "tsup src/cli.ts --format esm --watch",
|
|
38
|
+
"typecheck": "tsc --noEmit"
|
|
40
39
|
}
|
|
41
|
-
}
|
|
40
|
+
}
|