@livon/cli 0.27.0-rc.5 → 0.29.0-rc.1

package/README.md

@@ -1,19 +1,38 @@
+<!-- Generated from website/docs/packages/*.md. Do not edit directly. -->
+
 # @livon/cli
 
+
+[![npm](https://img.shields.io/npm/v/%40livon%2Fcli)](https://www.npmjs.com/package/@livon/cli)
+[![dependencies](https://img.shields.io/librariesio/release/npm/%40livon%2Fcli?label=dependencies)](https://libraries.io/npm/%40livon%2Fcli)
+[![npm publish](https://img.shields.io/github/actions/workflow/status/live-input-vector-output-node/livon-ts/publish.yml?branch=main&label=npm%20publish)](https://github.com/live-input-vector-output-node/livon-ts/actions/workflows/publish.yml)
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/12249/badge)](https://www.bestpractices.dev/projects/12249)
+[![Snyk security](https://snyk.io/test/npm/@livon/cli/badge.svg)](https://snyk.io/test/npm/@livon/cli)
+[![package size](https://img.shields.io/npm/unpacked-size/%40livon%2Fcli?label=package%20size)](https://www.npmjs.com/package/@livon/cli)
+[![license](https://img.shields.io/npm/l/%40livon%2Fcli)](https://www.npmjs.com/package/@livon/cli)
+
+## Purpose
+
+CLI for syncing [schema AST](https://livon.tech/docs/schema) from a running server and generating/updating client outputs.
+
+## Best for
+
+Use this package when you want generated client APIs to stay in sync during local development and CI.
+
 ## Install
 
 ```sh
 pnpm add -D @livon/cli
 ```
 
-## Purpose
-
-CLI for syncing [schema AST](https://live-input-vector-output-node.github.io/livon-ts/docs/schema) from a running server and generating/updating client outputs.
-
-## Basic command
+## Recommended command (sync + app)
 
 ```sh
-livon --endpoint ws://127.0.0.1:3002/ws --out src/generated/api.ts --poll 2000
+livon \
+  --endpoint ws://127.0.0.1:3002/ws \
+  --out src/generated/api.ts \
+  --poll 2000 \
+  -- pnpm dev
 ```
 
 ## Generated output mode
@@ -27,13 +46,7 @@ livon --endpoint ws://127.0.0.1:3002/ws --out src/generated/api.ts --poll 2000
 With `--out src/generated/api.ts`, compiled files are written to `src/generated/dist`.
 `livon` also writes `src/generated/package.json` with conditional exports, so `import { api } from './generated'` resolves to the matching build output.
 
-## Run sync and app command in one process
-
-You can append a command directly (without `&&`):
-
-```sh
-livon --endpoint ws://127.0.0.1:3002/ws --out src/generated/api.ts --poll 2000 pnpm dev
-```
+## Linked process lifecycle
 
 If the linked command exits, `livon` exits too.  
 If `livon` exits, it terminates the linked command.
@@ -46,12 +59,12 @@ livon --endpoint ws://127.0.0.1:3002/ws --out src/generated/api.ts -- --some-com
 
 ## Parameters
 
-- `--endpoint <ws-url>` (`string`): websocket endpoint used to fetch [schema explain data](https://live-input-vector-output-node.github.io/livon-ts/docs/packages/schema) (required unless `--port` is used).
+- `--endpoint <ws-url>` (`string`): websocket endpoint used to fetch [schema explain data](https://livon.tech/docs/packages/schema) (required unless `--port` is used).
 - `--port <number>` (`number`): overrides endpoint port when endpoint host/path stay unchanged.
 - `--out <file>` (`string`): output file path for generated API module.
 - `--poll <ms>` (`number`): polling interval for repeated sync runs.
 - `--timeout <ms>` (`number`): request timeout per sync call.
-- `--event <name>` (`string`): [schema explain](https://live-input-vector-output-node.github.io/livon-ts/docs/packages/schema) event name (default: `$explain`).
+- `--event <name>` (`string`): [schema explain](https://livon.tech/docs/packages/schema) event name (default: `$explain`).
 - `--method <GET|POST>` (`string`): request method for explain fetch.
 - `--header key:value` (`string`, repeatable): additional request header.
 - `--payload <json>` (`string`): raw JSON payload body for explain request.
@@ -63,12 +76,12 @@ livon --endpoint ws://127.0.0.1:3002/ws --out src/generated/api.ts -- --some-com
 
 ## Typical workflow
 
-1. Start server with [`schemaModule(..., { explain: true })`](https://live-input-vector-output-node.github.io/livon-ts/docs/packages/schema).
+1. Start server with [`schemaModule(..., { explain: true })`](https://livon.tech/docs/packages/schema).
 2. Run CLI in watch/poll mode during client development.
 3. Use generated API module in the client runtime.
 
 ## Related pages
 
-- [@livon/schema](https://live-input-vector-output-node.github.io/livon-ts/docs/packages/schema)
-- [@livon/client](https://live-input-vector-output-node.github.io/livon-ts/docs/packages/client)
-- [Getting Started](https://live-input-vector-output-node.github.io/livon-ts/docs/core/getting-started)
+- [@livon/schema](https://livon.tech/docs/packages/schema)
+- [@livon/client](https://livon.tech/docs/packages/client)
+- [Getting Started](https://livon.tech/docs/core/getting-started)

package/THIRD_PARTY_NOTICES.md

@@ -27,6 +27,32 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
+------------------------------------------------------------------------------
+ws
+------------------------------------------------------------------------------
+License: MIT
+
+Copyright (c) 2011 Einar Otto Stangvik <einaros@gmail.com>
+Copyright (c) 2013 Arnout Kazemier and contributors
+Copyright (c) 2016 Luigi Pinca and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 ------------------------------------------------------------------------------
 msgpackr
 ------------------------------------------------------------------------------