platformatic 1.37.1 → 1.39.0
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/help/gh.txt +8 -8
- package/help/help.txt +3 -4
- package/help/inject.txt +3 -3
- package/help/login.txt +1 -1
- package/help/upgrade.txt +8 -8
- package/package.json +13 -13
- package/help/deploy.txt +0 -64
package/help/gh.txt
CHANGED
|
@@ -13,14 +13,14 @@ Options:
|
|
|
13
13
|
|
|
14
14
|
If not specified, the configuration will be loaded from any of the following, in the current directory.
|
|
15
15
|
|
|
16
|
-
* `platformatic.
|
|
17
|
-
* `platformatic.
|
|
18
|
-
* `platformatic.
|
|
19
|
-
* `platformatic.
|
|
20
|
-
* `platformatic.
|
|
21
|
-
* `platformatic.
|
|
16
|
+
* `platformatic.json`, or
|
|
17
|
+
* `platformatic.yml`, or
|
|
18
|
+
* `platformatic.tml`, or
|
|
19
|
+
* `platformatic.json`, or
|
|
20
|
+
* `platformatic.yml`, or
|
|
21
|
+
* `platformatic.tml`
|
|
22
22
|
|
|
23
23
|
You can find more details about the configuration format here:
|
|
24
|
-
* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/
|
|
25
|
-
* [Platformatic Service Configuration](https://docs.platformatic.dev/docs/
|
|
24
|
+
* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
|
|
25
|
+
* [Platformatic Service Configuration](https://docs.platformatic.dev/docs/service/configuration)
|
|
26
26
|
|
package/help/help.txt
CHANGED
|
@@ -6,12 +6,11 @@ Welcome to Platformatic. Available commands are:
|
|
|
6
6
|
* `service` - start Platformatic Service; type `platformatic service help` to know more.
|
|
7
7
|
* `upgrade` - upgrade the Platformatic configuration to the latest version.
|
|
8
8
|
* `gh` - create a new gh action for Platformatic deployments.
|
|
9
|
-
* `deploy` - deploy a Platformatic application to the cloud.
|
|
10
9
|
* `runtime` - start Platformatic Runtime; type `platformatic runtime help` to know more.
|
|
11
10
|
* `start` - start a Platformatic application.
|
|
12
11
|
* `login` - generate a Platformatic login api key.
|
|
13
12
|
* `client` - generate a Platformatic client.
|
|
14
|
-
* `ps` - list all
|
|
15
|
-
* `logs` - stream logs for a
|
|
16
|
-
* `inject` - inject a request into a
|
|
13
|
+
* `ps` - list all Platformatic runtime applications.
|
|
14
|
+
* `logs` - stream logs for a Platformatic runtime application.
|
|
15
|
+
* `inject` - inject a request into a Platformatic runtime application.
|
|
17
16
|
* `ctl` - Platformatic Control commands; `platformatic ctl help` to know more.
|
package/help/inject.txt
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Injects a request to the
|
|
1
|
+
Injects a request to the Platformatic runtime service.
|
|
2
2
|
|
|
3
3
|
``` bash
|
|
4
4
|
$ platformatic inject -n runtime-name /hello
|
|
@@ -9,7 +9,7 @@ Injects a request to the platformatic runtime service.
|
|
|
9
9
|
|
|
10
10
|
Options:
|
|
11
11
|
|
|
12
|
-
* `-p, --pid <number>` - The process id of the runtime.
|
|
12
|
+
* `-p, --pid <number>` - The process `id` of the runtime.
|
|
13
13
|
* `-n, --name <string>` - The name of the runtime.
|
|
14
14
|
* `-s, --service <string>` - The name of the runtime service.
|
|
15
15
|
* `-X, --request <string>` - The request HTTP method. Default is `GET`.
|
|
@@ -21,7 +21,7 @@ Options:
|
|
|
21
21
|
|
|
22
22
|
The `inject` command sends a request to the runtime service and prints the
|
|
23
23
|
response to the standard output. If the `--service` option is not specified the
|
|
24
|
-
request is sent to the runtime
|
|
24
|
+
request is sent to the runtime entry point.
|
|
25
25
|
|
|
26
26
|
The `inject` command uses the Platformatic Runtime Management API. To enable it
|
|
27
27
|
set the `managementApi` option to `true` in the runtime configuration file.
|
package/help/login.txt
CHANGED
|
@@ -6,5 +6,5 @@ Generate a Platformatic login api key.
|
|
|
6
6
|
|
|
7
7
|
Options:
|
|
8
8
|
|
|
9
|
-
* `-c, --config FILE` - Specify a path to a global
|
|
9
|
+
* `-c, --config FILE` - Specify a path to a global Platformatic config file. Defaults to `~/.platformatic/config.json`.
|
|
10
10
|
* `--browser` - Automatically open default browser. If process stdout is a TTY, the default is `true`. Otherwise, the default is `false`.
|
package/help/upgrade.txt
CHANGED
|
@@ -10,13 +10,13 @@ Options:
|
|
|
10
10
|
|
|
11
11
|
If not specified, the configuration will be loaded from any of the following, in the current directory.
|
|
12
12
|
|
|
13
|
-
* `platformatic.
|
|
14
|
-
* `platformatic.
|
|
15
|
-
* `platformatic.
|
|
16
|
-
* `platformatic.
|
|
17
|
-
* `platformatic.
|
|
18
|
-
* `platformatic.
|
|
13
|
+
* `platformatic.json`, or
|
|
14
|
+
* `platformatic.yml`, or
|
|
15
|
+
* `platformatic.tml`, or
|
|
16
|
+
* `platformatic.json`, or
|
|
17
|
+
* `platformatic.yml`, or
|
|
18
|
+
* `platformatic.tml`
|
|
19
19
|
|
|
20
20
|
You can find more details about the configuration format here:
|
|
21
|
-
* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/
|
|
22
|
-
* [Platformatic Service Configuration](https://docs.platformatic.dev/docs/
|
|
21
|
+
* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
|
|
22
|
+
* [Platformatic Service Configuration](https://docs.platformatic.dev/docs/service/configuration)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "platformatic",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.39.0",
|
|
4
4
|
"description": "Platformatic CLI",
|
|
5
5
|
"main": "cli.js",
|
|
6
6
|
"type": "module",
|
|
@@ -51,18 +51,18 @@
|
|
|
51
51
|
"pino": "^8.19.0",
|
|
52
52
|
"pino-pretty": "^11.0.0",
|
|
53
53
|
"undici": "^6.9.0",
|
|
54
|
-
"@platformatic/
|
|
55
|
-
"@platformatic/client-cli": "1.
|
|
56
|
-
"@platformatic/
|
|
57
|
-
"@platformatic/control": "1.
|
|
58
|
-
"@platformatic/db": "1.
|
|
59
|
-
"@platformatic/deploy-client": "1.
|
|
60
|
-
"@platformatic/
|
|
61
|
-
"@platformatic/
|
|
62
|
-
"@platformatic/
|
|
63
|
-
"@platformatic/
|
|
64
|
-
"
|
|
65
|
-
"
|
|
54
|
+
"@platformatic/authenticate": "1.39.0",
|
|
55
|
+
"@platformatic/client-cli": "1.39.0",
|
|
56
|
+
"@platformatic/composer": "1.39.0",
|
|
57
|
+
"@platformatic/control": "1.39.0",
|
|
58
|
+
"@platformatic/db": "1.39.0",
|
|
59
|
+
"@platformatic/deploy-client": "1.39.0",
|
|
60
|
+
"@platformatic/config": "1.39.0",
|
|
61
|
+
"@platformatic/frontend-template": "1.39.0",
|
|
62
|
+
"@platformatic/runtime": "1.39.0",
|
|
63
|
+
"@platformatic/service": "1.39.0",
|
|
64
|
+
"@platformatic/utils": "1.39.0",
|
|
65
|
+
"create-platformatic": "1.39.0"
|
|
66
66
|
},
|
|
67
67
|
"scripts": {
|
|
68
68
|
"test": "pnpm run lint && borp --timeout 120000 --concurrency 1",
|
package/help/deploy.txt
DELETED
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
Deploys an application to the [Platformatic Cloud](https://docs.platformatic.dev/docs/category/platformatic-cloud).
|
|
2
|
-
|
|
3
|
-
``` bash
|
|
4
|
-
$ platformatic deploy
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
Options:
|
|
8
|
-
|
|
9
|
-
* `-t, --type static/dynamic` - The type of the workspace.
|
|
10
|
-
* `-c, --config FILE` - Specify a configuration file to use.
|
|
11
|
-
* `-k, --keys FILE` - Specify a path to the workspace keys file.
|
|
12
|
-
* `-l --label TEXT` - The deploy label. Only for dynamic workspaces.
|
|
13
|
-
* `-e --env FILE` - The environment file to use. Default: ".env"
|
|
14
|
-
* `-s --secrets FILE` - The secrets file to use. Default: ".secrets.env"
|
|
15
|
-
* `--workspace-id uuid` - The workspace id where the application will be deployed.
|
|
16
|
-
* `--workspace-key TEXT` - The workspace key where the application will be deployed.
|
|
17
|
-
|
|
18
|
-
1. To deploy a Platformatic application to the cloud, you should go to the Platformatic cloud dashboard and create a workspace.
|
|
19
|
-
2. Once you have created a workspace, retrieve your workspace id and key from the workspace settings page. Optionally, you can download the provided workspace env file, which you can use with the `--keys` option.
|
|
20
|
-
|
|
21
|
-
> :information_source:
|
|
22
|
-
>
|
|
23
|
-
> When deploying an application to a ***dynamic workspace***, specify the deploy `--label` option. You can find it on your cloud dashboard or you can specify a new one.
|
|
24
|
-
>
|
|
25
|
-
> If you do not specify an environment file to use with the `-e` flag, **ensure that a default environment file named `.env` exists**.
|
|
26
|
-
|
|
27
|
-
Deploy a **static** Platformatic Cloud application.
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
platformatic deploy \
|
|
31
|
-
-t static \
|
|
32
|
-
-c platformatic.db.json \
|
|
33
|
-
-e .env.prototype \
|
|
34
|
-
--workspace-id=00000000-0000-0000-0000-000000000000 \
|
|
35
|
-
--workspace-key=11111111111111111111111111111111
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
Deploy a **static** Platformatic Cloud application with a workspace keys file. The keys file can be downloaded from the Platformatic Console when generating a new API key.
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
platformatic deploy \
|
|
42
|
-
-t static \
|
|
43
|
-
-c platformatic.db.json \
|
|
44
|
-
-k foo.plt.txt
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
The `foo.plt.txt` must contain two variables for the workspace id and workspace API key.
|
|
48
|
-
|
|
49
|
-
```
|
|
50
|
-
# Contents of foo.plt.txt
|
|
51
|
-
PLATFORMATIC_STATIC_WORKSPACE_ID=00000000-0000-0000-0000-000000000000
|
|
52
|
-
PLATFORMATIC_STATIC_WORKSPACE_API_KEY=11111111111111111111111111111111
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
Deploy a **dynamic** Platformatic Cloud application.
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
platformatic deploy \
|
|
59
|
-
-t dynamic \
|
|
60
|
-
-c platformatic.db.json \
|
|
61
|
-
-l dev \
|
|
62
|
-
--workspace-id=00000000-0000-0000-0000-000000000000 \
|
|
63
|
-
--workspace-key=11111111111111111111111111111111
|
|
64
|
-
```
|