@fredlackey/cli-dokploy 0.0.2 → 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 +31 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,21 +8,26 @@ Command-line interface for the [Dokploy](https://dokploy.com) deployment platfor
|
|
|
8
8
|
npm install -g @fredlackey/cli-dokploy
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
Every command accepts credentials directly as flags. No setup step is required.
|
|
12
14
|
|
|
13
15
|
```
|
|
14
|
-
dokploy
|
|
16
|
+
dokploy project list \
|
|
15
17
|
--base-url http://dokploy.example.com:3000 \
|
|
16
18
|
--api-key <key>
|
|
17
|
-
```
|
|
18
19
|
|
|
19
|
-
|
|
20
|
+
dokploy application deploy \
|
|
21
|
+
--base-url http://dokploy.example.com:3000 \
|
|
22
|
+
--api-key <key> \
|
|
23
|
+
--id <applicationId>
|
|
24
|
+
```
|
|
20
25
|
|
|
21
|
-
|
|
26
|
+
If you've already run `dokploy configure`, you can omit the credential flags:
|
|
22
27
|
|
|
23
28
|
```
|
|
24
29
|
dokploy project list
|
|
25
|
-
dokploy
|
|
30
|
+
dokploy server list
|
|
26
31
|
dokploy postgres create \
|
|
27
32
|
--name mydb \
|
|
28
33
|
--app-name mydb \
|
|
@@ -36,7 +41,26 @@ dokploy domain create \
|
|
|
36
41
|
--certificate-type letsencrypt \
|
|
37
42
|
--strip-path false \
|
|
38
43
|
--application-id <id>
|
|
39
|
-
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Configure (Optional)
|
|
47
|
+
|
|
48
|
+
**The `configure` command is optional.** Every command accepts credentials directly as flags (e.g. `--api-key`, `--base-url`). You never need to run `configure` to use this tool. It exists as a convenience so you don't have to pass the same flags on every invocation.
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
dokploy configure \
|
|
52
|
+
--base-url http://dokploy.example.com:3000 \
|
|
53
|
+
--api-key <key>
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Running `dokploy configure` without flags prompts for each value interactively. Credentials are stored in `~/.config/cli-dokploy/config.json` and that file is the only config source. There are no environment variables to set.
|
|
57
|
+
|
|
58
|
+
If a required credential is missing at runtime, the error tells you exactly what to do:
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"error": "Missing required value: --api-key. Pass it as a flag or run \"dokploy configure\"."
|
|
63
|
+
}
|
|
40
64
|
```
|
|
41
65
|
|
|
42
66
|
## Full Command Reference
|