@livon/cli 0.27.0-rc.3 → 0.27.0-rc.5

package/LICENCE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 LIVON 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.

package/README.md

@@ -1,8 +1,74 @@
 # @livon/cli
 
-Package docs (GitHub Pages):
-- https://live-input-vector-output-node.github.io/livon-ts/docs/packages/cli
+## Install
 
-License:
-- MIT
-- Root license text: `../../LIZENZ.md`
+```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
+
+```sh
+livon --endpoint ws://127.0.0.1:3002/ws --out src/generated/api.ts --poll 2000
+```
+
+## Generated output mode
+
+`livon` always runs in `rslib` mode after sync.
+
+- default output: `esm + cjs + d.ts`
+- use `--esm` or `--cjs` to build only the selected format
+- use `--js` when you only need `esm + cjs` and want to skip declaration files
+
+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
+```
+
+If the linked command exits, `livon` exits too.  
+If `livon` exits, it terminates the linked command.
+
+If your linked command starts with flags, use `--` before it:
+
+```sh
+livon --endpoint ws://127.0.0.1:3002/ws --out src/generated/api.ts -- --some-command --flag
+```
+
+## 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).
+- `--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`).
+- `--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.
+- `--esm` (`boolean`): build only ESM output (`dist/index.js`).
+- `--cjs` (`boolean`): build only CJS output (`dist/index.cjs`).
+- `--js` (`boolean`): builds only `esm + cjs` (skips `.d.ts` output).
+- `--no-event` (`boolean`): disables event wrapping behavior for transports expecting plain request mode.
+- `--` (delimiter): separates livon flags from linked command arguments.
+
+## Typical workflow
+
+1. Start server with [`schemaModule(..., { explain: true })`](https://live-input-vector-output-node.github.io/livon-ts/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)

package/THIRD_PARTY_NOTICES.md

@@ -2,6 +2,31 @@ Third-Party Notices
 
 This package includes third-party software. The following licenses apply:
 
+------------------------------------------------------------------------------
+@rslib/core
+------------------------------------------------------------------------------
+License: MIT
+
+Copyright (c) 2024-present Bytedance, Inc. and its affiliates.
+
+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
 ------------------------------------------------------------------------------