platformatic 0.34.0 → 0.35.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/compile.txt +2 -3
- package/help/deploy.txt +14 -15
- package/help/gh.txt +17 -8
- package/help/help.txt +10 -10
- package/help/start.txt +3 -3
- package/help/upgrade.txt +14 -8
- package/package.json +13 -13
package/help/compile.txt
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
|
-
Compile all typescript plugins
|
|
1
|
+
Compile all typescript plugins.
|
|
2
2
|
|
|
3
3
|
``` bash
|
|
4
4
|
$ platformatic compile
|
|
5
5
|
```
|
|
6
6
|
|
|
7
|
-
This command will compile the TypeScript plugins for each
|
|
8
|
-
platformatic application.
|
|
7
|
+
This command will compile the TypeScript plugins for each platformatic application.
|
package/help/deploy.txt
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Deploys
|
|
1
|
+
Deploys an application to the [Platformatic Cloud](https://docs.platformatic.dev/docs/category/platformatic-cloud).
|
|
2
2
|
|
|
3
3
|
``` bash
|
|
4
4
|
$ platformatic deploy
|
|
@@ -6,19 +6,18 @@ Deploys a Platformatic application to the cloud
|
|
|
6
6
|
|
|
7
7
|
Options:
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
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
17
|
|
|
18
|
-
To deploy a Platformatic application to the cloud you should go to the
|
|
19
|
-
|
|
20
|
-
workspace id and key from the workspace settings page or download a workspace
|
|
21
|
-
env file and use it with the --keys option.
|
|
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.
|
|
22
20
|
|
|
23
|
-
|
|
24
|
-
|
|
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.
|
package/help/gh.txt
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Creates a gh action to deploy platformatic services on workspaces
|
|
1
|
+
Creates a gh action to deploy platformatic services on workspaces.
|
|
2
2
|
|
|
3
3
|
``` bash
|
|
4
4
|
$ platformatic gh -t dynamic
|
|
@@ -6,12 +6,21 @@ Creates a gh action to deploy platformatic services on workspaces
|
|
|
6
6
|
|
|
7
7
|
Options:
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
9
|
+
* `-w --workspace ID` - The workspace ID where the service will be deployed.
|
|
10
|
+
* `-t, --type static/dynamic` - The type of the workspace. Defaults to static.
|
|
11
|
+
* `-c, --config FILE` - Specify a configuration file to use.
|
|
12
|
+
* `-b, --build` - Build the service before deploying (`npm run build`).
|
|
13
13
|
|
|
14
|
-
If not specified, the configuration will be loaded from
|
|
15
|
-
|
|
16
|
-
`platformatic.
|
|
14
|
+
If not specified, the configuration will be loaded from any of the following, in the current directory.
|
|
15
|
+
|
|
16
|
+
* `platformatic.db.json`, or
|
|
17
|
+
* `platformatic.db.yml`, or
|
|
18
|
+
* `platformatic.db.tml`, or
|
|
19
|
+
* `platformatic.service.json`, or
|
|
20
|
+
* `platformatic.service.yml`, or
|
|
21
|
+
* `platformatic.service.tml`
|
|
22
|
+
|
|
23
|
+
You can find more details about the configuration format here:
|
|
24
|
+
* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/reference/db/configuration)
|
|
25
|
+
* [Platformatic Service Configuration](https://docs.platformatic.dev/docs/reference/service/configuration)
|
|
17
26
|
|
package/help/help.txt
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
Welcome to Platformatic. Available commands are:
|
|
2
2
|
|
|
3
|
-
* help - display this message
|
|
4
|
-
* help <command
|
|
5
|
-
* db - start Platformatic DB; type `platformatic db help` to know more.
|
|
6
|
-
* service - start Platformatic Service; type `platformatic service help` to know more.
|
|
7
|
-
* upgrade - upgrade the Platformatic configuration to the latest version.
|
|
8
|
-
* gh - create a new gh action for Platformatic deployments
|
|
9
|
-
* deploy - deploy a Platformatic application to the cloud
|
|
10
|
-
* runtime - start Platformatic Runtime; type `platformatic runtime help` to know more.
|
|
11
|
-
* start - start a Platformatic application
|
|
12
|
-
* frontend
|
|
3
|
+
* `help` - display this message.
|
|
4
|
+
* `help <command>` - show more information about a command.
|
|
5
|
+
* `db` - start Platformatic DB; type `platformatic db help` to know more.
|
|
6
|
+
* `service` - start Platformatic Service; type `platformatic service help` to know more.
|
|
7
|
+
* `upgrade` - upgrade the Platformatic configuration to the latest version.
|
|
8
|
+
* `gh` - create a new gh action for Platformatic deployments.
|
|
9
|
+
* `deploy` - deploy a Platformatic application to the cloud.
|
|
10
|
+
* `runtime` - start Platformatic Runtime; type `platformatic runtime help` to know more.
|
|
11
|
+
* `start` - start a Platformatic application.
|
|
12
|
+
* `frontend`- create frontend code to consume the REST APIs.
|
package/help/start.txt
CHANGED
|
@@ -6,6 +6,6 @@ $ platformatic start
|
|
|
6
6
|
|
|
7
7
|
Options:
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
* `-c, --config <path>` - Path to the configuration file.
|
|
10
|
+
* `--inspect[=[host:]port]` - Start the Node.js debugger. `host` defaults to `'127.0.0.1'`. `port` defaults to 9229. Use caution when binding to a public host:port combination.
|
|
11
|
+
* `--inspect-brk[=[host:]port]` - Start the Node.js debugger and block until a client has attached. `host` defaults to `'127.0.0.1'`. `port` defaults to 9229. Use caution when binding to a public host:port combination.
|
package/help/upgrade.txt
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Upgrade the Platformatic configuration to the latest version.
|
|
1
|
+
Upgrade the Platformatic schema configuration to the latest version.
|
|
2
2
|
|
|
3
3
|
``` bash
|
|
4
4
|
$ platformatic upgrade
|
|
@@ -6,11 +6,17 @@ Upgrade the Platformatic configuration to the latest version.
|
|
|
6
6
|
|
|
7
7
|
Options:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
* `-c, --config FILE` - Specify a schema configuration file to use.
|
|
10
10
|
|
|
11
|
-
If not specified, the configuration
|
|
12
|
-
|
|
13
|
-
`platformatic.
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
11
|
+
If not specified, the configuration will be loaded from any of the following, in the current directory.
|
|
12
|
+
|
|
13
|
+
* `platformatic.db.json`, or
|
|
14
|
+
* `platformatic.db.yml`, or
|
|
15
|
+
* `platformatic.db.tml`, or
|
|
16
|
+
* `platformatic.service.json`, or
|
|
17
|
+
* `platformatic.service.yml`, or
|
|
18
|
+
* `platformatic.service.tml`
|
|
19
|
+
|
|
20
|
+
You can find more details about the configuration format here:
|
|
21
|
+
* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/reference/db/configuration)
|
|
22
|
+
* [Platformatic Service Configuration](https://docs.platformatic.dev/docs/reference/service/configuration)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "platformatic",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.35.0",
|
|
4
4
|
"description": "Platformatic CLI",
|
|
5
5
|
"main": "cli.js",
|
|
6
6
|
"type": "module",
|
|
@@ -48,18 +48,18 @@
|
|
|
48
48
|
"minimist": "^1.2.8",
|
|
49
49
|
"pino": "^8.14.1",
|
|
50
50
|
"pino-pretty": "^10.0.0",
|
|
51
|
-
"@platformatic/authenticate": "0.
|
|
52
|
-
"@platformatic/client-cli": "0.
|
|
53
|
-
"@platformatic/composer": "0.
|
|
54
|
-
"@platformatic/config": "0.
|
|
55
|
-
"@platformatic/db": "0.
|
|
56
|
-
"@platformatic/deploy-client": "0.
|
|
57
|
-
"@platformatic/frontend-template": "0.
|
|
58
|
-
"@platformatic/
|
|
59
|
-
"@platformatic/
|
|
60
|
-
"@platformatic/
|
|
61
|
-
"
|
|
62
|
-
"
|
|
51
|
+
"@platformatic/authenticate": "0.35.0",
|
|
52
|
+
"@platformatic/client-cli": "0.35.0",
|
|
53
|
+
"@platformatic/composer": "0.35.0",
|
|
54
|
+
"@platformatic/config": "0.35.0",
|
|
55
|
+
"@platformatic/db": "0.35.0",
|
|
56
|
+
"@platformatic/deploy-client": "0.35.0",
|
|
57
|
+
"@platformatic/frontend-template": "0.35.0",
|
|
58
|
+
"@platformatic/metaconfig": "0.35.0",
|
|
59
|
+
"@platformatic/runtime": "0.35.0",
|
|
60
|
+
"@platformatic/service": "0.35.0",
|
|
61
|
+
"@platformatic/start": "0.35.0",
|
|
62
|
+
"create-platformatic": "0.35.0"
|
|
63
63
|
},
|
|
64
64
|
"scripts": {
|
|
65
65
|
"test": "standard | snazzy && c8 --100 tap --no-coverage test/*.test.js",
|