@omochi-ui/cli 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,279 @@
-# Temporary Holding Version
+# CLI reference
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Overview](../../README.md) · [Architecture](../../docs/architecture.md) · [Discovery guide](../../docs/discovery.md)
+
+Build the workspace with `bun install` and `bun run build`. Run commands from its
+root using `bun run omochi-ui`; the binary is provided by `@omochi-ui/cli`; the TypeScript SDK is
+`@omochi-ui/sdk`.
+
+```sh
+bun run omochi-ui --help
+bun run omochi-ui hub --help
+bun run omochi-ui help generate catalog
+```
+
+No arguments prints the overview. `-h`, `--help`, and `help <command>` print help
+to stdout and exit successfully without starting services or changing config.
+Invalid arguments print usage to stderr and exit with code 2.
+
+## Command map
+
+| Task | Command | Browser UI included? |
+| --- | --- | --- |
+| Start a project composition | `up [FILE]` | Yes; `--open` opens it automatically |
+| Develop a single app | `dev -- <command> [args...]` | Start the Vite preview separately |
+| Compose dashboards from running apps | `hub` | Yes |
+| Publish this machine's running apps | `gateway` | No; connect a hub |
+| Show or name this machine | `id` | No |
+| Pair with a TCP gateway | `pair HOST:PORT` | No |
+| Inspect or remove paired peers | `trust list`, `trust forget <nodeId>` | No |
+| Generate SDK catalog types | `generate catalog` | No |
+
+## up
+
+Start local services, the hub, and a read-only dashboard preset from TOML.
+
+```sh
+bun run omochi-ui up --open
+bun run omochi-ui up --port 5557 ./examples/quickstart/omochi.toml
+```
+
+The file defaults to `./omochi.toml`. A service uses either a literal `command`
+or an `omochi-utils` shorthand. Commands do not use a shell; relative working
+directories are resolved from the composition file. Child services receive
+`OMOCHI_SERVICE` and remain independent: one exiting leaves its panel unavailable
+without stopping the others. Utility shorthand supports `button`, `watch`,
+`process`, `tail`, and `http`. Stdio-owned `stream` and `mcp` processes stay
+external; this lets an agent connect and disconnect independently of the preset.
+
+```toml
+version = 1
+id = "local-development"
+
+[services.health]
+utility = ["http", "http://127.0.0.1:5173/"]
+
+[services.app]
+command = ["uv", "run", "app.py"]
+cwd = "./backend"
+
+[dashboard]
+name = "Local development"
+
+[[dashboard.rows]]
+panels = ["health", "app"]
+height = "medium"
+
+[dashboard.panels.health]
+title = "Health"
+service = "health"
+
+[dashboard.panels.app]
+title = "Application"
+service = "app"
+```
+
+Rows divide the twelve-column dashboard evenly. Heights are `small`, `medium`,
+or `large`; a panel's surface defaults to `main`. Presets do not modify saved
+dashboard storage. Use **Save as dashboard** in the hub to make an editable copy.
+Ctrl+C stops only the services and gateway started by this command.
+
+| Option | Meaning | Default |
+| --- | --- | --- |
+| `--host HOST` | Hub bind address | `127.0.0.1` |
+| `--port PORT` | Hub port; `0` chooses an available port | `5555` |
+| `--allow-origin ORIGIN` | Add an exact browser origin; repeatable | Loopback origins only |
+| `--open` | Open the selected preset in the desktop browser | Off |
+
+## dev
+
+Launch a child application and bridge its JSONL stdin/stdout to WebSocket.
+
+```sh
+# Terminal 1: browser preview
+bun run --filter @omochi-ui/dev-server dev
+# Terminal 2: app + bridge
+bun run omochi-ui dev -- uv run --project examples/python examples/python/app.py
+```
+
+Open `http://127.0.0.1:5173/`. The preview's default `/ws` proxy reaches the bridge.
+All arguments after `--` belong to the child, including any `--help` flag.
+Application logging must go to stderr; stdout is reserved for A2UI JSONL.
+
+| Option | Meaning | Default |
+| --- | --- | --- |
+| `--host HOST` | Bridge bind address | `127.0.0.1` |
+| `--port PORT` | Bridge port; `0` chooses an available port | `5555` |
+
+The bridge serves WebSocket at `/ws`; it does not serve an HTML page. Startup
+prints a preview URL with `?ws=` for its actual address. The preview must already
+be running; use its printed port if Vite selected one other than 5173.
+All clients share application state, and late clients receive a current snapshot.
+The bridge has no authentication or TLS; keep the loopback default.
+
+## hub
+
+Serve the dashboard UI, discover available surfaces, and route browser actions.
+Apps must already be running with `UnixSocketServerTransport`. The bundled
+examples select that transport when `OMOCHI_SERVICE` is set.
+
+```sh
+# Terminal 1
+OMOCHI_SERVICE=python-example uv run --project examples/python examples/python/app.py
+# Terminal 2
+bun run omochi-ui hub
+```
+
+Open `http://127.0.0.1:5555/`. The hub serves its own UI and automatically starts
+a local gateway when none is listening. It reuses an existing gateway and does
+not stop a gateway it did not start.
+
+| Option | Meaning | Default |
+| --- | --- | --- |
+| `--host HOST` | HTTP/WebSocket bind address | `127.0.0.1` |
+| `--port PORT` | HTTP/WebSocket port; `0` chooses an available port | `5555` |
+| `--gateway TARGET` | Unix socket path or `<nodeId>@HOST:PORT`; repeatable | Local gateway |
+| `--ssh HOST` | SSH hostname, alias, or `user@host`; one target | Off |
+| `--ssh-socket PATH` | Remote gateway socket override; requires `--ssh` | Resolved through SSH |
+| `--no-auto-gateway` | Do not start a missing local gateway | Auto-start enabled |
+| `--discover-lan` | Also look for paired gateways via mDNS | Off |
+| `--allow-origin ORIGIN` | Add an exact allowed browser origin; repeatable | Loopback origins only |
+
+Explicit `--gateway` or `--ssh` targets replace the default local gateway. Add
+`--gateway /path/to/local/gateway.sock` to include it too. Explicit targets can
+be combined with `--discover-lan`. A TCP target needs its paired node ID; a Unix
+socket or SSH target does not need pairing.
+
+```sh
+# Remote machine: gateway and apps must already be running
+bun run omochi-ui gateway
+# Local machine: SSH authenticates and forwards the remote gateway socket
+bun run omochi-ui hub --ssh user@remote
+```
+
+The hub has no authentication or TLS on its browser-facing listener. Keep its
+loopback binding. See [SSH setup](../../docs/discovery.md#connecting-through-ssh)
+for requirements and cleanup behavior.
+
+## gateway
+
+Discover the current user's apps and publish their surfaces. A gateway does not
+launch apps or serve the dashboard UI. It normally listens only on a Unix socket.
+
+```sh
+bun run omochi-ui gateway
+```
+
+| Option | Meaning | Default |
+| --- | --- | --- |
+| `--root DIR` | Directory containing service manifests and sockets | `$XDG_RUNTIME_DIR/omochi` |
+| `--socket PATH` | Gateway Unix socket | `<root>/gateway.sock` |
+| `--node-name NAME` | Persist this machine's display name | Existing name or hostname |
+| `--listen HOST:PORT` | Enable the TLS TCP listener | Off |
+| `--advertise` | Advertise over mDNS; requires a TCP listener | Off |
+| `--pair` | Open a one-time pairing window; requires a TCP listener | Off |
+| `--lan` | `--listen 0.0.0.0:5556 --advertise` | Off |
+
+If `XDG_RUNTIME_DIR` is unset, the registry uses
+`<system temporary directory>/omochi-<uid>/omochi`. Apps and gateways must use the
+same runtime directory. See [Service discovery](../../docs/discovery.md) for the
+manifest format and SDK transport examples.
+
+Network reachability, advertisement, and trust are separate. `--listen` enables
+the paired TLS listener; mDNS only advertises its location. Neither allows an
+unpaired hub to read application data.
+
+## pair
+
+Pair once before connecting a hub to a gateway over TCP. SSH does not require this.
+
+```sh
+# Machine running the apps: open a TCP listener and pairing window
+bun run omochi-ui gateway --lan --pair
+# Machine running the hub: enter the code printed by the gateway
+bun run omochi-ui pair 192.168.1.42:42317  # use the random pairing port printed above
+```
+
+`pair HOST:PORT` reads the code from stdin. `--code CODE` supplies it explicitly;
+stdin keeps it out of shell history. The window lasts three minutes, permits
+five exchange attempts, and closes after one successful pairing. Its dedicated HTTPS
+listener uses a random port and exposes no application API. Normal connections use
+mutual TLS with pinned device certificates; legacy PSK peers must pair again.
+
+After success, run the printed `hub --gateway <nodeId>@HOST:PORT` command, prefixed
+with `bun run` in a source checkout. Alternatively, use `hub --discover-lan`
+when the gateway advertises on the same local network. mDNS generally does not
+cross VLANs or VPNs.
+
+## id and trust
+
+```sh
+bun run omochi-ui id
+bun run omochi-ui id --node-name workstation
+bun run omochi-ui trust list
+bun run omochi-ui trust forget NODE_ID
+```
+
+`id` creates a persistent identity on first use and prints its node ID and name.
+Changing the name preserves the ID. `trust list` prints peer IDs, roles, names,
+and pairing times. `trust forget` removes the local peer entry and waits for running local processes
+to close affected connections before reporting success; it returns code
+1 when the peer does not exist. Pair again to establish trust after removal.
+
+## generate catalog
+
+Generate typed bindings from a local A2UI v0.9 catalog for any subset of SDKs.
+Create output directories before running the command.
+
+```sh
+mkdir -p generated
+bun run omochi-ui generate catalog \
+  --catalog ./catalog.json \
+  --name ProductCatalog \
+  --typescript ./generated/product-catalog.ts \
+  --python ./generated/product_catalog.py \
+  --rust ./generated/product_catalog.rs
+```
+
+| Option | Meaning |
+| --- | --- |
+| `--catalog FILE` | Required catalog JSON input |
+| `--name NAME` | Type name; defaults to catalog title or `GeneratedCatalog` |
+| `--typescript FILE` | TypeScript output |
+| `--python FILE` | Python output |
+| `--rust FILE` | Rust output |
+| `--check` | Check outputs without writing; fail if missing or stale |
+
+At least one output flag is required. Generation resolves local schemas only;
+it does not fetch schemas over the network. Reuse the same invocation with
+`--check` in CI.
+
+## Ports and storage
+
+| Resource | Default |
+| --- | --- |
+| Vite browser preview | `http://127.0.0.1:5173/` |
+| Development bridge | `ws://127.0.0.1:5555/ws` |
+| Hub UI / A2UI | `http://127.0.0.1:5555/` / `ws://127.0.0.1:5555/ws` |
+| Gateway Unix socket | `$XDG_RUNTIME_DIR/omochi/gateway.sock` (fallback above) |
+| Gateway TCP with `--lan` | `0.0.0.0:5556` (paired TLS) |
+| Node identity and peers | `$XDG_CONFIG_HOME/omochi/{node,peers}.json` |
+| Saved dashboards | `$XDG_CONFIG_HOME/omochi/dashboards.json` |
+
+`XDG_CONFIG_HOME` defaults to `~/.config`. Runtime directories and configuration
+are per-user; identity and trust persist across restarts. Dashboard files store
+names, surface references, and layouts, not app state.
+
+## Troubleshooting
+
+| Symptom | What to check |
+| --- | --- |
+| `dev` starts but there is no page | Start `bun run --filter @omochi-ui/dev-server dev` and open its URL, not port 5555 |
+| Preview says disconnected | Start the bridge; with a custom port, use the printed `?ws=` URL |
+| Address already in use | `dev` and `hub` share default port 5555; stop one or set `--port 5557` |
+| Vite uses a port other than 5173 | Use Vite's printed URL, adding the bridge's `?ws=` parameter if needed |
+| Hub has no apps | Run an app with `OMOCHI_SERVICE` set and the same user/runtime directory |
+| Hub loses the local apps when using SSH | Explicit targets replace the local default; add the local socket with `--gateway` |
+| Pairing/advertising requires a listener | Use `gateway --lan --pair` or provide `--listen HOST:PORT` |
+| Remote gateway is not found | Check that it is running; use SSH or an explicit paired TCP target when multicast is unavailable |
+| Command or build output is missing | Run `bun install` and `bun run build` from the repository root |

package/bin/omochi-ui.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env bun
+import '../dist/cli.js'

package/dist/catalog-codegen.d.ts

@@ -0,0 +1,9 @@
+export interface GenerateCatalogOptions {
+    catalog: string;
+    name?: string;
+    typescript?: string;
+    python?: string;
+    rust?: string;
+    check?: boolean;
+}
+export declare function generateCatalog(options: GenerateCatalogOptions): Promise<void>;