linc-cli-kit 0.1.1__py3-none-any.whl

linc_cli_kit-0.1.1.dist-info/METADATA

@@ -0,0 +1,201 @@
+Metadata-Version: 2.5
+Name: linc-cli-kit
+Version: 0.1.1
+Summary: Reflect a FastMCP tool registry into Click commands under one agent-grade output contract
+Project-URL: Homepage, https://github.com/LincForge/cli-kit
+Project-URL: Issues, https://github.com/LincForge/cli-kit/issues
+Author: LINC Innovations
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.12
+Requires-Dist: click>=8.1
+Requires-Dist: mcp<2,>=1.26
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.9; extra == 'dev'
+Requires-Dist: structlog>=24.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# linc-cli-kit
+
+Turn a [FastMCP](https://github.com/modelcontextprotocol/python-sdk) tool registry into a Click
+CLI with one agent-grade output contract: JSON on stdout, a structured error envelope on stderr,
+exit codes `0`/`1`/`2`, and a `schema --json` dump of the whole command tree. An importable
+conformance suite proves the CLI still matches the MCP tools. An agent that has learned one CLI
+built this way has learned them all.
+
+## Install
+
+```bash
+pip install linc-cli-kit        # or: uv add linc-cli-kit
+```
+
+Python 3.12+. Runtime dependencies: `click` and `mcp`.
+
+## Example
+
+Save as `hello_cli.py`:
+
+```python
+import click
+from mcp.server.fastmcp import FastMCP
+
+from linc_cli_kit import LocalTransport, install_globals, mount_tools
+
+server = FastMCP("hello")
+
+
+@server.tool()
+def hello_greet(name: str, times: int = 1) -> dict:
+    """Greet someone. Example: hello greet --name Ada --times 2"""
+    return {"greeting": " ".join([f"Hello, {name}!"] * times)}
+
+
+@click.group()
+def main() -> None:
+    """hello: JSON on stdout by default, --human for text."""
+
+
+install_globals(main)
+mount_tools(main, server, prefix="hello_", transport=LocalTransport())
+
+if __name__ == "__main__":
+    main()
+```
+
+```console
+$ python hello_cli.py greet --name Ada --times 2
+{"greeting": "Hello, Ada! Hello, Ada!"}
+
+$ python hello_cli.py greet; echo "exit=$?"
+{"error": {"code": "USAGE_ERROR", "message": "Missing option '--name'.", "hint": "", "category": "validation", "retryable": false, "details": {}}}
+exit=2
+
+$ python hello_cli.py schema --json     # the whole command tree, for an agent to read once
+```
+
+The error envelope goes to stderr and stdout stays empty, so `python hello_cli.py greet | jq`
+never parses half a document.
+
+## Wiring a real tool
+
+```python
+# src/<tool>/cli/main.py: a real tool with an optional local daemon
+import sys
+import click
+from linc_cli_kit import (
+    HttpDaemonTransport, LocalTransport, configure_structlog_stderr,
+    install_globals, mount_tools,
+)
+
+configure_structlog_stderr()   # MUST be above your package imports — see below
+
+from <tool>.mcp._core import server            # noqa: E402
+from <tool>.core.controller import Controller  # noqa: E402
+
+
+@click.group()
+def main() -> None:
+    """<tool> — JSON on stdout by default; --human for text, --stream for JSON Lines."""
+
+
+install_globals(main)          # adds the global flags; mount_tools refuses to run without it
+main.add_command(my_hand_written_command)      # hand-written commands win on name collision
+
+mount_tools(
+    main, server, prefix="<tool>_",
+    transport=HttpDaemonTransport(
+        "<tool>", "http://127.0.0.1:8111",
+        fallback=LocalTransport(before=ensure_initialized),
+        daemon_only=frozenset({"<tool>_diff"}),   # tools that need the daemon's in-memory state
+    ),
+    skip={"<tool>_internal": "why this tool has no CLI surface"},
+    renderers={"state": render_state},            # --human text per command
+)
+```
+
+**Why `configure_structlog_stderr()` goes above the imports:** modules bind their logger at
+import time, so a later call leaves already-bound loggers writing to stdout — which corrupts
+the JSON payload and breaks `<tool> <cmd> | jq`. Same reason `install_globals` calls
+`configure_stderr_logging()` for stdlib logging.
+
+**Transports.** `LocalTransport(fn_for=..., before=...)` calls the tool function in-process
+(`before` runs one-time init; `fn_for` swaps in a different callable per spec).
+`HttpDaemonTransport(tool, default_url, fallback=..., daemon_only=..., timeout=...)` posts to
+`{base}/tools/{name}`. It resolves the base from `LINC_<TOOL>_DAEMON`, then
+`$LINC_HOME/<tool>/daemon.port` (`LINC_HOME` defaults to `~/.linc`), then `default_url`, and
+falls back to `fallback` when the daemon is down. It never falls back on a **timeout**: the
+daemon is still executing the tool, so a retry would run it twice.
+[nerve](https://github.com/LincForge/nerve) is the worked example.
+
+## Conformance test
+
+```python
+from linc_cli_kit import assert_cli_parity
+from <tool>.cli.main import main, _registry_server
+
+
+def test_cli_parity() -> None:
+    report = assert_cli_parity(
+        main, _registry_server(), prefix="<tool>_",
+        skip={"<tool>_internal": "why this tool has no CLI surface"},
+        samples={"<tool>_screenshot": {"device": "emulator-5554"}},
+    )
+    assert report.tools >= 40
+```
+
+Rules the suite enforces, so read them before adding a command:
+
+- **Every hand-written override needs a `samples[<tool_name>]` entry.** Without one the suite
+  fails closed rather than silently skipping the override's JSON contract.
+- **Overrides must route through the group transport** (`ctx.find_root().command.linc_transport`),
+  not call the tool function directly, so the suite's stubbed error payloads reach them and the
+  exit-code contract is actually exercised. An override that never calls the transport (it
+  hard-codes or locally computes its output) fails, with or without a sample.
+- Generated commands are checked for option parity, `--help`, the payload handed to the
+  transport, and execution consistency against a direct `LocalTransport` call.
+- **A sampled generated command runs once through the real transport with the process stdout
+  captured** at the file-descriptor level. A tool that prints, or a structlog logger bound to
+  stdout at import, or a child process inheriting fd 1, fails the suite: in a real CLI process
+  those bytes would land in the JSON payload.
+- Reserved option names — `json`, `human`, `stream`, `output`, `timeout`, `log_level`, `help`,
+  `yes` — are remapped to `--arg-<name>` on generated commands.
+
+## Output contract
+
+| | |
+|---|---|
+| Default | bare JSON on stdout, one document, no ANSI — strict JSON (no `NaN`/`Infinity`) |
+| Encoding | dataclass → object · pydantic → `model_dump(mode="json")` · set → sorted list · bytes → base64 string · datetime/date/time → ISO 8601 · other → `str()`. A non-finite float is a `NON_JSON_VALUE` error (exit `1`), never invalid JSON. `linc_cli_kit.to_json` / `json_default` expose the same encoder |
+| Modes | `--json` (default), `--human`, `--stream` (JSON Lines), or `LINC_OUTPUT=json\|human\|jsonl` |
+| Failure | **empty stdout**, one `{"error": {code, message, hint, category, retryable, details}}` line on stderr — always the **last** line (see below) |
+| Exit codes | `0` success · `1` tool/internal error · `2` usage/validation error |
+| Discovery | `<tool> schema --json` dumps the whole command tree — no `--help` crawl |
+| Artifacts | `-o/--output PATH` writes binary content and returns a `{type, path, bytes, sha256}` reference |
+| Other globals | `--timeout SECONDS`, `--log-level LEVEL`; logs and heartbeats are stderr-only |
+| Signals | SIGTERM → exit `143`, SIGINT → exit `130` with an `INTERRUPTED` envelope; both unwind the stack (`finally` / context managers run). SIGTERM is not optional: a watchdog hard-exits after `LINC_SIGNAL_GRACE` seconds (default 10; `inf` = never) if the unwind stalls, and a second SIGTERM (more than 0.5s after the first) hard-exits at once. SIGINT keeps Python's semantics — every Ctrl-C raises `KeyboardInterrupt` |
+
+**Parsing stderr.** stderr may carry more than the envelope. A long call writes one
+heartbeat line every 10s (`{"event": "heartbeat", "label": ..., "elapsed_s": ...}`, or
+`[label] Ns elapsed` under `--human`), and stdlib/structlog logging goes to stderr too. So do
+not `json.loads` the whole stream. The envelope is the **last line**: read
+`stderr.strip().splitlines()[-1]`, or call `linc_cli_kit.parse_error_envelope(stderr)`. It
+returns the last line that is an `{"error": {...}}` object, or `None`.
+
+A hand-written command or group callback that raises is wrapped the same way as a generated
+command: envelope, exit `1` (or the `ToolError`'s own `exit_code`), and no traceback.
+
+## How this repo works
+
+This is a release mirror of a private LINC repository. The code is built by LINC's AI software
+factory under human review, and each release lands here as one commit. Issues are welcome; see
+[CONTRIBUTING.md](CONTRIBUTING.md). To report a security problem, see [SECURITY.md](SECURITY.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+---
+
+Built by [LINC Innovations](https://lincinnovations.com/audit?utm_source=github&utm_medium=readme&utm_campaign=cli-kit). We diagnose flaky device test suites.

linc_cli_kit-0.1.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+linc_cli_kit/__init__.py,sha256=BqqKI0LrQpt09C-ihbgBIiZTYR0CspNGWoqqBtMiGhw,1973
+linc_cli_kit/errors.py,sha256=dpMiW_5Oo_-flBDae_JAUIHCQimV5wlmpRdbOMCyr6A,4260
+linc_cli_kit/logging.py,sha256=ToVvK19v2p8F1RGOBNkml-Z8C7zIsmhDNdXQhO8AYSY,1268
+linc_cli_kit/mount.py,sha256=5krpSjAF4wT_xJ_xPjMvKBT3nqHk8tfmf4xLmWsygIc,11503
+linc_cli_kit/output.py,sha256=pWsf73Jq2dlpO6N8w-W6IRGKtK9CIt9LEXfFMLok7MU,15905
+linc_cli_kit/registry.py,sha256=gi1frzA_0YfwyBvLaFpx_u238o96GkkPP9IRTrx-kwM,1593
+linc_cli_kit/schema.py,sha256=ztN9PCuy30GQY4arpxj6ebVkFJBhRsIZjU-M_uqOLCw,5221
+linc_cli_kit/testing.py,sha256=D1jKtJ2oEBTlCmn-xDHhZpeK5dkk3OkxiaVdSNLE4Io,20390
+linc_cli_kit/transport.py,sha256=qa9t8JfGQv8D0l980-nLSmS--ukLbFvwV2WjMgMUVSU,5255
+linc_cli_kit-0.1.1.dist-info/METADATA,sha256=eqldDUatYTEn5xrFceWzePZM5Etp0SodLqeWboXlk08,9027
+linc_cli_kit-0.1.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+linc_cli_kit-0.1.1.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+linc_cli_kit-0.1.1.dist-info/licenses/NOTICE,sha256=EWyv194tD9JyCjMTsUlz1IaaQyaVlykhb7Os3x_JqdI,49
+linc_cli_kit-0.1.1.dist-info/RECORD,,

linc_cli_kit-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

linc_cli_kit-0.1.1.dist-info/licenses/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.

linc_cli_kit-0.1.1.dist-info/licenses/NOTICE

@@ -0,0 +1,2 @@
+LINC CLI Kit
+Copyright 2026 LINC Innovations LLC