platformatic 1.22.0 → 1.24.0

package/cli.js

@@ -16,8 +16,13 @@ import helpMe from 'help-me'
 import { upgrade } from './lib/upgrade.js'
 import { gh } from './lib/gh.js'
 import { deploy } from './lib/deploy.js'
-
 import { logo } from './lib/ascii.js'
+import {
+  runControl,
+  getRuntimesCommand,
+  injectRuntimeCommand,
+  streamRuntimeLogsCommand
+} from '@platformatic/control/control.js'
 
 const program = commist({ maxDistance: 2 })
 const help = helpMe({
@@ -44,6 +49,10 @@ program.register('runtime', async (args) => ensureCommand(await runRuntime(args)
 program.register('service', async (args) => ensureCommand(await runService(args)))
 program.register('composer', async (args) => ensureCommand(await runComposer(args)))
 program.register('start', async (args) => ensureCommand(await startCommand(args)))
+program.register('ctl', async (args) => ensureCommand(await runControl(args)))
+program.register('ps', async (args) => getRuntimesCommand(args))
+program.register('inject', async (args) => injectRuntimeCommand(args))
+program.register('logs', async (args) => streamRuntimeLogsCommand(args))
 program.register('upgrade', upgrade)
 program.register('client', client)
 program.register('compile', compile)

package/help/help.txt

@@ -11,3 +11,7 @@ Welcome to Platformatic. Available commands are:
 * `start` - start a Platformatic application.
 * `login` - generate a Platformatic login api key.
 * `client` - generate a Platformatic client.
+* `ps` - list all platformatic runtime applications.
+* `logs` - stream logs for a platformatic runtime application.
+* `inject` - inject a request into a platformatic runtime application.
+* `ctl` - Platformatic Control commands; `platformatic ctl help` to know more.

package/help/inject.txt

@@ -0,0 +1,29 @@
+Injects a request to the platformatic runtime service.
+
+``` bash
+  $ platformatic inject -n runtime-name /hello
+     -X POST
+     -H "Content-Type: application/json"
+     -d '{"key": "value"}'
+```
+
+Options:
+
+* `-p, --pid <number>` - The process id of the runtime.
+* `-n, --name <string>` - The name of the runtime.
+* `-s, --service <string>` - The name of the runtime service.
+* `-X, --request <string>` - The request HTTP method. Default is `GET`.
+* `-H, --header <string>` - The request header. Can be used multiple times.
+* `-d, --data <string>` - The request data.
+* `-i, --include <boolean>` - Include the response headers in the output. Default is `false`.
+* `-o, --output <file>` - Write the response to the specified file.
+
+The `inject` command sends a request to the runtime service and prints the
+response to the standard output. If the `--service` option is not specified the
+request is sent to the runtime entrypoint.
+
+The `inject` command uses the Platformatic Runtime Management API. To enable it
+set the `managementApi` option to `true` in the runtime configuration file.
+
+To get the list of runtimes with enabled management API use the
+`platformatic ctl ps` command.

package/help/logs.txt

@@ -0,0 +1,21 @@
+Streams logs from the platformatic runtime application.
+
+``` bash
+  $ platformatic logs -n runtime-name
+```
+
+Options:
+
+* `-p, --pid <number>` - The process id of the runtime.
+* `-n, --name <string>` - The name of the runtime.
+* `-l, --level <string>` - The pino log level to stream. Default is `info`.
+* `-s, --service <string>` - The name of the service to stream logs from.
+* `--pretty` <boolean> - Pretty print the logs. Default is `true`.
+
+If `--service` is not specified, the command will stream logs from all services.
+
+The `logs` command uses the Platformatic Runtime Management API. To enable it
+set the `managementApi` option to `true` in the runtime configuration file.
+
+To get the list of runtimes with enabled management API use the
+`platformatic ctl ps` command.

package/help/ps.txt

@@ -0,0 +1,10 @@
+Lists all running platformatic runtime applications.
+
+``` bash
+  $ platformatic ps
+```
+
+To see the list of all available control commands, run `platformatic ctl help`.
+
+The `ps` command uses the Platformatic Runtime Management API. To enable it
+set the `managementApi` option to `true` in the runtime configuration file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "platformatic",
-  "version": "1.22.0",
+  "version": "1.24.0",
   "description": "Platformatic CLI",
   "main": "cli.js",
   "type": "module",
@@ -51,18 +51,19 @@
     "pino": "^8.17.2",
     "pino-pretty": "^10.3.1",
     "undici": "^6.6.0",
-    "@platformatic/authenticate": "1.22.0",
-    "@platformatic/client-cli": "1.22.0",
-    "@platformatic/composer": "1.22.0",
-    "@platformatic/config": "1.22.0",
-    "@platformatic/db": "1.22.0",
-    "@platformatic/frontend-template": "1.22.0",
-    "@platformatic/deploy-client": "1.22.0",
-    "@platformatic/metaconfig": "1.22.0",
-    "@platformatic/runtime": "1.22.0",
-    "@platformatic/service": "1.22.0",
-    "@platformatic/utils": "1.22.0",
-    "create-platformatic": "1.22.0"
+    "@platformatic/authenticate": "1.24.0",
+    "@platformatic/client-cli": "1.24.0",
+    "@platformatic/config": "1.24.0",
+    "@platformatic/composer": "1.24.0",
+    "@platformatic/control": "1.24.0",
+    "@platformatic/deploy-client": "1.24.0",
+    "@platformatic/metaconfig": "1.24.0",
+    "@platformatic/frontend-template": "1.24.0",
+    "@platformatic/db": "1.24.0",
+    "@platformatic/runtime": "1.24.0",
+    "@platformatic/service": "1.24.0",
+    "create-platformatic": "1.24.0",
+    "@platformatic/utils": "1.24.0"
   },
   "scripts": {
     "test": "pnpm run lint && borp --timeout 120000 --concurrency 1",