systemlink-cli 1.9.4__tar.gz → 1.11.0__tar.gz

{systemlink_cli-1.9.4 → systemlink_cli-1.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: systemlink-cli
-Version: 1.9.4
+Version: 1.11.0
 Summary: SystemLink Integrator CLI - cross-platform CLI for SystemLink workflows and templates.
 License-File: LICENSE
 Author: Fred Visser

{systemlink_cli-1.9.4 → systemlink_cli-1.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "systemlink-cli"
-version = "1.9.4"
+version = "1.11.0"
 description = "SystemLink Integrator CLI - cross-platform CLI for SystemLink workflows and templates."
 authors = ["Fred Visser <fred.visser@emerson.com>"]
 packages = [{ include = "slcli" }]

{systemlink_cli-1.9.4 → systemlink_cli-1.11.0}/slcli/_version.py

@@ -1,4 +1,4 @@
 """Version information for slcli."""
 
 # This file is auto-generated. Do not edit manually.
-__version__ = "1.9.4"
+__version__ = "1.11.0"

{systemlink_cli-1.9.4 → systemlink_cli-1.11.0}/slcli/main.py

@@ -30,6 +30,7 @@ from .rich_output import install_rich_output
 from .rich_output import render_table
 from .routine_click import register_routine_commands
 from .skill_click import register_skill_commands
+from .spec_click import register_spec_commands
 from .ssl_trust import OS_TRUST_INJECTED, OS_TRUST_REASON
 from .system_click import register_system_commands
 from .tag_click import register_tag_commands
@@ -365,6 +366,11 @@ def info(format: str, skip_health: bool) -> None:
         workspace_display = truncate(workspace)
         info_rows.append(["Workspace", workspace_display])
 
+    system_query_endpoint = platform_info.get("system_query_endpoint")
+    if system_query_endpoint:
+        system_query_display = truncate(str(system_query_endpoint))
+        info_rows.append(["System Query", system_query_display])
+
     file_query_endpoint = platform_info.get("file_query_endpoint")
     if file_query_endpoint:
         if (
@@ -427,6 +433,7 @@ register_notebook_commands(cli)
 register_policy_commands(cli)
 register_routine_commands(cli)
 register_system_commands(cli)
+register_spec_commands(cli)
 register_tag_commands(cli)
 register_testmonitor_commands(cli)
 register_webapp_commands(cli)

{systemlink_cli-1.9.4 → systemlink_cli-1.11.0}/slcli/mcp_reachability.py

@@ -35,6 +35,17 @@ def is_reachability_failure(exc: BaseException) -> bool:
             return True
 
         message = str(candidate).lower()
+        if "/mcp" in message and any(
+            token in message
+            for token in (
+                "server error",
+                "not found",
+                "method not allowed",
+                "bad request",
+            )
+        ):
+            return True
+
         if any(
             token in message
             for token in (

{systemlink_cli-1.9.4 → systemlink_cli-1.11.0}/slcli/mcp_server.py

@@ -271,7 +271,41 @@ def query_systems(
     take: int = 100,
 ) -> str:
     """Query systems by alias, connection state, workspace, or raw filter."""
-    from .utils import get_base_url
+    import requests as requests_lib
+
+    from .system_query_utils import (
+        MATERIALIZED_SYSTEM_MCP_PROJECTION,
+        build_materialized_system_search_filter,
+        get_system_query_url,
+        get_system_search_url,
+    )
+    from .utils import make_api_request
+
+    materialized_filter = None
+    if filter is None:
+        materialized_filter = build_materialized_system_search_filter(
+            alias=alias,
+            state=state,
+            workspace_id=workspace,
+        )
+
+    if filter is None:
+        search_payload: Dict[str, Any] = {
+            "take": take,
+            "projection": MATERIALIZED_SYSTEM_MCP_PROJECTION,
+        }
+        if materialized_filter:
+            search_payload["filter"] = materialized_filter
+        try:
+            data = make_api_request(
+                "POST",
+                get_system_search_url(),
+                payload=search_payload,
+                handle_errors=False,
+            ).json()
+            return _dump(_normalize_systems(data))
+        except requests_lib.RequestException:
+            pass
 
     filter_parts: List[str] = []
     if alias:
@@ -283,11 +317,16 @@ def query_systems(
     if filter:
         filter_parts.append(filter)
 
-    payload: Dict[str, Any] = {"take": take}
+    query_payload: Dict[str, Any] = {"take": take}
     if filter_parts:
-        payload["filter"] = " and ".join(filter_parts)
-
-    data = _post_json(f"{get_base_url()}/nisysmgmt/v1/query-systems", payload)
+        query_payload["filter"] = " and ".join(filter_parts)
+
+    data = make_api_request(
+        "POST",
+        get_system_query_url(),
+        payload=query_payload,
+        handle_errors=False,
+    ).json()
     return _dump(_normalize_systems(data))
 
 

{systemlink_cli-1.9.4 → systemlink_cli-1.11.0}/slcli/platform.py

@@ -59,6 +59,8 @@ FEATURE_DISPLAY_NAMES: Dict[str, str] = {
 FILE_SEARCH_PATH = "/nifile/v1/service-groups/Default/search-files"
 FILE_QUERY_PATH = "/nifile/v1/service-groups/Default/query-files"
 FILE_QUERY_LINQ_PATH = "/nifile/v1/service-groups/Default/query-files-linq"
+SYSTEM_SEARCH_PATH = "/nisysmgmt/v1/materialized/search-systems"
+SYSTEM_QUERY_PATH = "/nisysmgmt/v1/query-systems"
 
 
 def _get_keyring_config() -> Dict[str, Any]:
@@ -195,7 +197,7 @@ SERVICE_CHECKS: List[List[str]] = [
     ["Auth", "GET", "/niauth/v1/policies"],
     ["Test Monitor", "GET", "/nitestmonitor/v2/results?take=0"],
     ["Asset Management", "POST", "/niapm/v1/query-assets"],
-    ["Systems", "POST", "/nisysmgmt/v1/query-systems"],
+    ["Systems", "POST", SYSTEM_QUERY_PATH],
     ["Tag", "GET", "/nitag/v2/tags?take=0"],
     ["File", "POST", FILE_SEARCH_PATH],
     ["Notebook", "POST", "/ninotebook/v1/notebook/query"],
@@ -319,6 +321,87 @@ def get_file_query_capability(api_url: str, api_key: str) -> Dict[str, Any]:
         }
 
 
+def get_system_query_capability(api_url: str, api_key: str) -> Dict[str, Any]:
+    """Determine which systems query endpoint is available for this server."""
+    headers = {
+        "x-ni-api-key": api_key,
+        "Content-Type": "application/json",
+        "User-Agent": "SystemLink-CLI/1.0 (cross-platform)",
+    }
+    ssl_verify = get_ssl_verify()
+
+    try:
+        search_resp = requests.post(
+            f"{api_url}{SYSTEM_SEARCH_PATH}",
+            headers=headers,
+            json={"take": 1, "projection": ["id"]},
+            verify=ssl_verify,
+            timeout=10,
+        )
+        if search_resp.status_code in (200, 400):
+            return {
+                "status": "ok",
+                "system_query_endpoint": "search-systems",
+                "materialized_search_available": True,
+            }
+        if search_resp.status_code in (401, 403):
+            return {
+                "status": "unauthorized",
+                "system_query_endpoint": "search-systems",
+                "materialized_search_available": True,
+            }
+        if search_resp.status_code not in (404, 501):
+            return {
+                "status": "error" if search_resp.status_code >= 500 else "not_found",
+                "system_query_endpoint": None,
+                "materialized_search_available": True,
+            }
+    except requests.RequestException:
+        return {
+            "status": "unreachable",
+            "system_query_endpoint": None,
+            "materialized_search_available": None,
+        }
+
+    try:
+        query_resp = requests.post(
+            f"{api_url}{SYSTEM_QUERY_PATH}",
+            headers=headers,
+            json={"take": 1, "projection": "new(id)"},
+            verify=ssl_verify,
+            timeout=10,
+        )
+        if query_resp.status_code in (200, 400):
+            return {
+                "status": "ok",
+                "system_query_endpoint": "query-systems",
+                "materialized_search_available": False,
+            }
+        if query_resp.status_code in (401, 403):
+            return {
+                "status": "unauthorized",
+                "system_query_endpoint": "query-systems",
+                "materialized_search_available": False,
+            }
+        if query_resp.status_code in (404, 501):
+            return {
+                "status": "not_found",
+                "system_query_endpoint": None,
+                "materialized_search_available": False,
+            }
+        return {
+            "status": "error",
+            "system_query_endpoint": None,
+            "materialized_search_available": False,
+        }
+    except requests.RequestException:
+        return {
+            "status": "unreachable",
+            "system_query_endpoint": None,
+            "materialized_search_available": False,
+        }
+
+
 def check_service_status(api_url: str, api_key: str) -> Dict[str, Any]:
     """Probe key SystemLink services and report their status.
 
@@ -334,10 +417,12 @@ def check_service_status(api_url: str, api_key: str) -> Dict[str, Any]:
         - auth_valid: bool | None - whether the API key is authorized (None if unreachable)
         - services: dict mapping service name to status string
           ("ok", "unauthorized", "not_found", "error", "unreachable")
-                - file_query_endpoint: selected file query endpoint, if available
-                - elasticsearch_available: bool | None - whether search-files is available
-                - platform: detected platform string (PLATFORM_SLE, PLATFORM_SLS,
-                    PLATFORM_UNREACHABLE, PLATFORM_UNKNOWN)
+        - file_query_endpoint: selected file query endpoint, if available
+        - elasticsearch_available: bool | None - whether search-files is available
+        - system_query_endpoint: selected systems query endpoint, if available
+        - materialized_search_available: bool | None - whether search-systems is available
+        - platform: detected platform string (PLATFORM_SLE, PLATFORM_SLS,
+          PLATFORM_UNREACHABLE, PLATFORM_UNKNOWN)
     """
     headers = {
         "x-ni-api-key": api_key,
@@ -396,6 +481,8 @@ def check_service_status(api_url: str, api_key: str) -> Dict[str, Any]:
             "services": services,
             "file_query_endpoint": None,
             "elasticsearch_available": None,
+            "system_query_endpoint": None,
+            "materialized_search_available": None,
             "platform": PLATFORM_UNREACHABLE,
         }
 
@@ -416,6 +503,8 @@ def check_service_status(api_url: str, api_key: str) -> Dict[str, Any]:
 
     file_capability = get_file_query_capability(api_url, api_key)
     services["File"] = file_capability["status"]
+    system_capability = get_system_query_capability(api_url, api_key)
+    services["Systems"] = system_capability["status"]
 
     return {
         "server_reachable": True,
@@ -423,6 +512,8 @@ def check_service_status(api_url: str, api_key: str) -> Dict[str, Any]:
         "services": services,
         "file_query_endpoint": file_capability["file_query_endpoint"],
         "elasticsearch_available": file_capability["elasticsearch_available"],
+        "system_query_endpoint": system_capability["system_query_endpoint"],
+        "materialized_search_available": system_capability["materialized_search_available"],
         "platform": platform,
     }
 
@@ -473,6 +564,8 @@ def get_platform_info(skip_health: bool = False) -> Dict[str, Any]:
     platform = stored_platform
     file_query_endpoint: Optional[str] = None
     elasticsearch_available: Optional[bool] = None
+    system_query_endpoint: Optional[str] = None
+    materialized_search_available: Optional[bool] = None
 
     if not skip_health and logged_in and isinstance(api_url, str) and api_url != "Not configured":
         status = check_service_status(api_url, api_key)
@@ -482,6 +575,8 @@ def get_platform_info(skip_health: bool = False) -> Dict[str, Any]:
         platform = status["platform"]
         file_query_endpoint = status.get("file_query_endpoint")
         elasticsearch_available = status.get("elasticsearch_available")
+        system_query_endpoint = status.get("system_query_endpoint")
+        materialized_search_available = status.get("materialized_search_available")
 
     info: Dict[str, Any] = {
         "api_url": api_url,
@@ -497,6 +592,10 @@ def get_platform_info(skip_health: bool = False) -> Dict[str, Any]:
         info["file_query_endpoint"] = file_query_endpoint
     if elasticsearch_available is not None:
         info["elasticsearch_available"] = elasticsearch_available
+    if system_query_endpoint is not None:
+        info["system_query_endpoint"] = system_query_endpoint
+    if materialized_search_available is not None:
+        info["materialized_search_available"] = materialized_search_available
 
     if services is not None:
         info["services"] = services

systemlink_cli-1.11.0/slcli/skills/slcli/SKILL.md

@@ -0,0 +1,180 @@
+---
+name: slcli
+description: >-
+  Query and manage NI SystemLink resources using the slcli command-line interface.
+  Covers test results, assets, systems, tags, feeds, files, notebooks,
+  routines, work items, work item templates, workflows, test plan templates,
+  specifications, products, datasheet-to-specification ingestion (PDF and CSV),
+  custom fields, web applications, authorization policies, users, workspaces, and more.
+  Use when the user asks about test data analysis, asset management, calibration status,
+  system fleet health, operator performance, failure analysis, production metrics,
+  equipment utilization, work order tracking, specification management,
+  importing datasheets, creating products from spec sheets,
+  or any SystemLink resource operations.
+  Supports filtering, aggregation, summary statistics, and JSON output for programmatic processing.
+argument-hint: >-
+  Describe what you want to do: query test results, import a datasheet,
+  list assets, manage work items, etc.
+compatibility: >-
+  Requires slcli installed and authenticated (slcli login). Python 3.10+.
+  Requires network access to a SystemLink server instance.
+metadata:
+  author: ni-kismet
+  version: "2.0"
+#   --system SYSTEM_ID    Assign a system (by minion/system ID). Repeatable.
+#   --fixture ASSET_ID    Assign a fixture/slot (by asset ID, asset type FIXTURE). Repeatable.
+#   --dut ASSET_ID        Assign a DUT (by asset ID, asset type DEVICE_UNDER_TEST). Repeatable.
+# Use `slcli asset list --asset-type FIXTURE` to find fixture IDs.
+# Use `slcli system list` to find system IDs.
+# At least one option must be provided; time and resource options can be combined freely.
+slcli workitem schedule <WORK_ITEM_ID> \
+  [--start ISO8601] [--end ISO8601] [--duration SECONDS] \
+  [--assigned-to USER_ID] \
+  [--system SYSTEM_ID]... [--fixture ASSET_ID]... [--dut ASSET_ID]...
+
+# Work item template subgroup
+slcli workitem template list [-w WORKSPACE] [--filter TEXT] [-t INT] [-f json]
+slcli workitem template get <TEMPLATE_ID> [-f json]
+slcli workitem template create --name TEXT --type TEXT --template-group TEXT [-w WORKSPACE] [OPTIONS]
+slcli workitem template update <TEMPLATE_ID> [--name TEXT] [--description TEXT] [--summary TEXT]
+slcli workitem template delete <TEMPLATE_ID>... [--yes]
+
+# Workflow subgroup
+slcli workitem workflow list [-w WORKSPACE] [-t INT] [-f json]
+slcli workitem workflow get [--id WORKFLOW_ID] [--name NAME] [-f json]
+slcli workitem workflow init [--name TEXT] [--directory DIR]   # Scaffold a local workflow file
+slcli workitem workflow create --file PATH [-w WORKSPACE]      # Create from JSON file
+slcli workitem workflow import --file PATH [-w WORKSPACE]      # Import workflow from JSON
+slcli workitem workflow export [--id WORKFLOW_ID] [--name NAME] [-o FILE]  # Export to JSON
+slcli workitem workflow update --id WORKFLOW_ID --file PATH    # Update from JSON file
+slcli workitem workflow delete --id WORKFLOW_ID [--yes]
+slcli workitem workflow preview [--file PATH] [--id WORKFLOW_ID] [--html] [--no-open] [-o FILE]
+```
+
+**Create work item options:**
+
+```bash
+slcli workitem create \
+  --name "Battery Cycle Test" \
+  --type testplan \
+  --state NEW \
+  --part-number "P-BAT-001" \
+  --description "Battery capacity test" \
+  --assigned-to <user-id> \
+  --workflow-id <workflow-id> \
+  --workspace Default \
+  --format json
+```
+
+### workflow — Workflow management
+
+> **Note:** The standalone `slcli workflow` command group has been replaced by
+> `slcli workitem workflow`. Use `slcli workitem workflow` for all workflow operations.
+> See the **workitem** section above.
+
+### webapp — Web application management
+
+Scaffold, package, and publish custom web applications to SystemLink.
+
+```bash
+slcli webapp init <DIRECTORY>                      # Scaffold the Angular starter
+slcli webapp manifest init <DIRECTORY> [OPTIONS]  # Create nipkg.config.json for packaging
+slcli webapp pack [FOLDER] [--config FILE] [-o OUTPUT_FILE]  # Package a webapp into a .nipkg
+slcli webapp list [-w WORKSPACE] [-t INT] [-f json]
+slcli webapp get <WEBAPP_ID> [-f json]
+slcli webapp publish PATH [--workspace NAME]             # Upload and publish a webapp
+slcli webapp delete <WEBAPP_ID>
+slcli webapp open <WEBAPP_ID>                            # Open webapp URL in browser
+```
+
+`webapp init` creates the SystemLink Angular starter, not a generic HTML app. The starter installs
+project-scoped skills into `.agents/skills/` and creates `PROMPTS.md` plus `START_HERE.md` so an
+AI assistant can bootstrap the Angular workspace in place with the same Nimble/SystemLink
+conventions described by the `systemlink-webapp` skill.
+
+`webapp manifest init` writes `nipkg.config.json` using the Plugin Manager field names
+(`section`, `maintainer`, `homepage`, `xbPlugin`, `slPluginManagerTags`,
+`slPluginManagerMinServerVersion`, `iconFile`). `webapp pack --config ...` consumes that
+metadata, carries the icon into the package, writes the matching control-file fields into the
+generated `.nipkg`, and emits a thin `manifest.json` with `schemaVersion`, `nipkgFile`,
+`sha256`, and any configured provenance fields.
+
+### skill — AI skill installation
+
+Install bundled skills for supported AI clients.
+
+```bash
+slcli skill install --skill [slcli|systemlink-webapp|systemlink-notebook|all] --client [agents|claude|all] --scope [personal|project|both]
+```
+
+Client paths:
+
+- `agents` — personal: `~/.agents/skills/`, project: `.agents/skills/` (most agents)
+- `claude` — personal: `~/.claude/skills/`, project: `.claude/skills/`
+- `all` — install to both the `agents` and `claude` locations for the selected scope
+
+Notes:
+
+- `agents` is the default client in interactive mode.
+- `webapp init` installs project-scoped skills into `.agents/skills/` by default.
+
+### example — Built-in example resource provisioning
+
+Install pre-built demo configurations (systems, assets, DUTs, templates, etc.)
+for training, testing, or evaluation.
+
+```bash
+slcli example list [-f json]                             # List available examples
+slcli example info <EXAMPLE_ID>                          # Show example details
+slcli example install <EXAMPLE_ID> [--workspace NAME]    # Provision example resources
+slcli example delete <EXAMPLE_ID> [--workspace NAME]     # Remove provisioned resources
+```
+
+## Reference docs
+
+Consult these for detailed guidance. Load only what you need for the current task.
+
+| Topic                       | File                                                        | When to load                                                  |
+| --------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------- |
+| CLI command reference       | [commands.md](./references/commands.md)                     | Looking up command syntax, options, or examples               |
+| Datasheet-to-specs workflow | [datasheet-workflow.md](./references/datasheet-workflow.md) | Importing specs from PDF, CSV, or structured text             |
+| Filtering guide             | [filtering.md](./references/filtering.md)                   | Advanced LINQ expressions, parameterized queries              |
+| Analysis recipes            | [analysis-recipes.md](./references/analysis-recipes.md)     | Multi-step analysis: yield, calibration, operator performance |
+| Troubleshooting             | [troubleshooting.md](./references/troubleshooting.md)       | Workspace ID issues, SSL errors, encoding, PowerShell quoting |
+
+## Command groups at a glance
+
+| Group         | Purpose                 | Key subcommands                                      |
+| ------------- | ----------------------- | ---------------------------------------------------- |
+| `testmonitor` | Test results & products | `result list/get`, `product list/create/update`      |
+| `spec`        | Specifications          | `list`, `query`, `get`, `create`, `import`, `export` |
+| `asset`       | Assets & calibration    | `list`, `get`, `summary`, `calibration`              |
+| `system`      | System fleet            | `list`, `get`, `compare`, `summary`, `job`           |
+| `tag`         | Tag read/write          | `list`, `get-value`, `set-value`, `create`           |
+| `routine`     | Event-action routines   | `list`, `create`, `enable/disable` (v1 + v2)         |
+| `comment`     | Resource comments       | `list`, `add`, `update`, `delete`                    |
+| `workitem`    | Work items & workflows  | `list`, `create`, `schedule`, `template`, `workflow` |
+| `file`        | File management         | `list`, `upload`, `download`, `query`, `watch`       |
+| `notebook`    | Jupyter notebooks       | `manage list/create`, `execute start/sync`           |
+| `feed`        | Package feeds           | `list`, `create`, `package upload`                   |
+| `customfield` | Dynamic form fields     | `list`, `create`, `export`, `edit`                   |
+| `template`    | Test plan templates     | `list`, `import`, `export`                           |
+| `webapp`      | Web applications        | `init`, `pack`, `publish`, `list`                    |
+| `config`      | Connection profiles     | `list`, `use`, `add`, `delete`                       |
+| `user`        | User management         | `list`, `get`, `create`, `update`                    |
+| `auth`        | Authorization policies  | `policy list/create`, `template list`                |
+| `workspace`   | Workspaces              | `list`, `get`                                        |
+| `skill`       | AI skill installation   | `install`                                            |
+| `example`     | Demo provisioning       | `list`, `install`, `delete`                          |
+## Key rules
+
+1. **Always use `-f json`** when piping output to `jq` or doing programmatic analysis.
+2. **Use `--summary --group-by`** for aggregation instead of fetching all records and counting.
+3. **Use convenience filters first** (e.g., `--status FAILED`), fall back to `--filter` for complex queries.
+4. **Parameterize `--filter` queries** — use `--substitution` instead of string interpolation.
+5. **Combine filters** — convenience filters are ANDed together automatically.
+6. **Use `--take`** to control result volume; JSON returns all matching up to `--take`.
+7. **Status enum values**: `PASSED`, `FAILED`, `RUNNING`, `ERRORED`, `TERMINATED`, `TIMEDOUT`, `WAITING`, `SKIPPED`, `CUSTOM`.
+8. **Exit codes**: 0 = success, 1 = general error, 2 = invalid input, 3 = not found, 4 = permission denied, 5 = network error.
+9. **Prefer workspace IDs** (UUIDs) over names in scripted workflows — some endpoints reject names.
+10. **Use `make_api_request`** from `slcli.utils` for helper scripts — handles auth, SSL, and errors.