licos-platform-cli 0.3.3__tar.gz → 0.4.0__tar.gz

{licos_platform_cli-0.3.3 → licos_platform_cli-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: licos-platform-cli
-Version: 0.3.3
+Version: 0.4.0
 Summary: LICOS platform CLI
 Requires-Python: >=3.10
-Requires-Dist: licos-platform-sdk>=0.4.2
+Requires-Dist: licos-platform-sdk>=0.5.0

{licos_platform_cli-0.3.3 → licos_platform_cli-0.4.0}/pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "hatchling.build"
 
 [project]
 name = "licos-platform-cli"
-version = "0.3.3"
+version = "0.4.0"
 description = "LICOS platform CLI"
 requires-python = ">=3.10"
 dependencies = [
-    "licos-platform-sdk>=0.4.2",
+    "licos-platform-sdk>=0.5.0",
 ]
 
 [project.scripts]

{licos_platform_cli-0.3.3 → licos_platform_cli-0.4.0}/src/licos_platform_cli/help_commands.py

@@ -508,10 +508,10 @@ UNS_HELP = {
         "discover, validate, plan, and finalize are read-only for external systems; apply performs writes.",
         "Run apply only after reviewing the current plan, and pass its exact documentHash and planHash with --confirm.",
         "UNS.json must not contain platform IDs, external IDs, credentials, MQTT infrastructure IDs, or credential-bearing RTSP URLs.",
-        "Use resource-search before reference bindings; a reference selector must resolve exactly one existing resource.",
-        "Point nodes are message-backed. New manifests and changes do not create point storage; existing point storage remains unchanged and does not block point operations.",
-        "Use UNSChangeSet for supported isolated structural changes. Remove storage only on an explicit confirmed request. Unsupported operations must fail; do not regenerate a full manifest or call external services directly.",
-        "Use either a current-project node code or --path for business access. Data writes/deletions, point control, and video control require explicit confirmation.",
+        "Use resource-search before reference bindings; a reference selector must resolve exactly one existing resource.",
+        "Point nodes are message-backed. New manifests and changes do not create point storage; existing point storage remains unchanged and does not block point operations.",
+        "Use UNSChangeSet for supported isolated structural changes. Remove storage only on an explicit confirmed request. Unsupported operations must fail; do not regenerate a full manifest or call external services directly.",
+        "Use either a current-project node code or --path for business access. Data writes/deletions, point control, and video control require explicit confirmation.",
     ],
     "sdk": {
         "python": "from licos_platform_sdk import uns\nplanned = uns.plan(document)\nresult = uns.apply(document, expected_document_hash=planned['documentHash'], expected_plan_hash=planned['planHash'], confirmed=True)",
@@ -583,7 +583,7 @@ UNS_HELP = {
             "parameters": [{"name": "--file", "required": True, "description": "Local UNS JSON file."}],
             "example": "licos-platform uns plan --file UNS.json",
         },
-        "apply": {
+        "apply": {
             "description": "Execute a previously reviewed plan after explicit confirmation and hash verification.",
             "parameters": [
                 {"name": "--file", "required": True, "description": "The exact local UNS JSON document that was planned."},
@@ -591,90 +591,90 @@ UNS_HELP = {
                 {"name": "--plan-hash", "required": True, "description": "planHash returned by the reviewed plan."},
                 {"name": "--confirm", "required": True, "description": "Explicitly confirm external writes."},
             ],
-            "example": "licos-platform uns apply --file UNS.json --document-hash <documentHash> --plan-hash <planHash> --confirm",
-        },
-        "changes-validate": {
-            "description": "Validate one strict UNSChangeSet document without writes.",
-            "parameters": [{"name": "--file", "required": True, "description": "Local UNSChangeSet JSON file."}],
-            "example": "licos-platform uns changes-validate --file UNS.change.json",
-        },
-        "changes-plan": {
-            "description": "Resolve targets and create a read-only plan for one UNSChangeSet.",
-            "parameters": [{"name": "--file", "required": True, "description": "Local UNSChangeSet JSON file."}],
-            "example": "licos-platform uns changes-plan --file UNS.change.json",
-        },
-        "changes-apply": {
-            "description": "Apply the exact reviewed UNSChangeSet; destructive or replacement actions require impact confirmation.",
-            "parameters": [
-                {"name": "--file", "required": True, "description": "The exact UNSChangeSet document that was planned."},
-                {"name": "--document-hash", "required": True, "description": "documentHash returned by changes-plan."},
-                {"name": "--plan-hash", "required": True, "description": "planHash returned by changes-plan."},
-                {"name": "--confirm", "required": True, "description": "Confirm the planned writes."},
-                {"name": "--confirm-impact", "required": False, "description": "Additionally confirm delete, move, replacement, or rebind impact."},
-            ],
-            "example": "licos-platform uns changes-apply --file UNS.change.json --document-hash <documentHash> --plan-hash <planHash> --confirm --confirm-impact",
-        },
-        "node-update": {
-            "description": "Build and plan one supported node metadata update; this command never applies it.",
-            "parameters": [
-                {"name": "--path / --node-code", "required": True, "description": "Exactly one project-local target locator."},
-                {"name": "--set-json", "required": True, "description": "Supported node fields to replace."},
-            ],
-            "example": "licos-platform uns node-update --path project:/LINE_1/TEMP_1 --set-json '{\"name\":\"炉温\"}'",
-        },
-        "node-move": {
-            "description": "Build and plan one project-local node move; this command never applies it.",
-            "parameters": [
-                {"name": "--path / --node-code", "required": True, "description": "Exactly one target locator."},
-                {"name": "--parent-path / --parent-node-code", "required": True, "description": "Exactly one destination locator."},
-            ],
-            "example": "licos-platform uns node-move --node-code TEMP_1 --parent-path project:/LINE_2",
-        },
-        "point-rebind": {
-            "description": "Build and plan rebinding one point to one exact existing collection point; this command never applies it.",
-            "parameters": [
-                {"name": "--path / --node-code", "required": True, "description": "Exactly one point target locator."},
-                {"name": "--selector-json", "required": True, "description": "Exact tagCode, taskName, and protocol selector."},
-                {"name": "--field-mappings-json", "required": False, "description": "Optional field mapping array."},
-            ],
-            "example": "licos-platform uns point-rebind --node-code TEMP_1 --selector-json '{\"tagCode\":\"T1\",\"taskName\":\"OPC采集\",\"protocol\":\"opcua\"}'",
-        },
-        "directory-create": {
-            "description": "Build and plan creating one project-local grouping directory; this command never applies it.",
-            "parameters": [
-                {"name": "--parent-path / --parent-node-code", "required": True, "description": "Exactly one parent locator."},
-                {"name": "--node-json", "required": True, "description": "Directory name, stable code, and optional metadata."},
-            ],
-            "example": "licos-platform uns directory-create --parent-path project:/ --node-json '{\"name\":\"一号产线\",\"code\":\"LINE_1\"}'",
-        },
-        "connection-update": {
-            "description": "生成并规划一个当前项目托管采集连接的增量修改，不直接执行写入。",
-            "parameters": [
-                {"name": "--selector-json", "required": True, "description": "精确的 name、protocol 选择器。"},
-                {"name": "--set-json", "required": True, "description": "name、credentialRef 或 configPatch。"},
-                {"name": "--output", "required": False, "description": "在项目目录内保存生成的 UNSChangeSet。"},
-            ],
-            "example": "licos-platform uns connection-update --selector-json '{\"name\":\"一号PLC\",\"protocol\":\"modbus-tcp\"}' --set-json '{\"configPatch\":{\"host\":\"10.0.0.2\"}}' --output UNS.change.json",
-        },
-        "collection-task-update": {
-            "description": "生成并规划一个当前项目托管采集任务的增量修改，不直接执行写入。",
-            "parameters": [
-                {"name": "--selector-json", "required": True, "description": "精确的 name、protocol、connectionName 选择器。"},
-                {"name": "--set-json", "required": True, "description": "name、pollIntervalMs、enabled 或 configPatch。"},
-                {"name": "--output", "required": False, "description": "在项目目录内保存生成的 UNSChangeSet。"},
-            ],
-            "example": "licos-platform uns collection-task-update --selector-json '{\"name\":\"温度采集\",\"protocol\":\"modbus-tcp\",\"connectionName\":\"一号PLC\"}' --set-json '{\"pollIntervalMs\":2000}' --output UNS.change.json",
-        },
-        "point-config-update": {
-            "description": "生成并规划一个当前项目托管采集点位配置的增量修改，不改变点位编码和所属任务。",
-            "parameters": [
-                {"name": "--selector-json", "required": True, "description": "精确的 tagCode、taskName、protocol 选择器。"},
-                {"name": "--set-json", "required": True, "description": "点位通用字段或协议 addressPatch。"},
-                {"name": "--output", "required": False, "description": "在项目目录内保存生成的 UNSChangeSet。"},
-            ],
-            "example": "licos-platform uns point-config-update --selector-json '{\"tagCode\":\"TEMP_01\",\"taskName\":\"温度采集\",\"protocol\":\"modbus-tcp\"}' --set-json '{\"addressPatch\":{\"address\":\"40002\"}}' --output UNS.change.json",
-        },
-        "finalize": {
+            "example": "licos-platform uns apply --file UNS.json --document-hash <documentHash> --plan-hash <planHash> --confirm",
+        },
+        "changes-validate": {
+            "description": "Validate one strict UNSChangeSet document without writes.",
+            "parameters": [{"name": "--file", "required": True, "description": "Local UNSChangeSet JSON file."}],
+            "example": "licos-platform uns changes-validate --file UNS.change.json",
+        },
+        "changes-plan": {
+            "description": "Resolve targets and create a read-only plan for one UNSChangeSet.",
+            "parameters": [{"name": "--file", "required": True, "description": "Local UNSChangeSet JSON file."}],
+            "example": "licos-platform uns changes-plan --file UNS.change.json",
+        },
+        "changes-apply": {
+            "description": "Apply the exact reviewed UNSChangeSet; destructive or replacement actions require impact confirmation.",
+            "parameters": [
+                {"name": "--file", "required": True, "description": "The exact UNSChangeSet document that was planned."},
+                {"name": "--document-hash", "required": True, "description": "documentHash returned by changes-plan."},
+                {"name": "--plan-hash", "required": True, "description": "planHash returned by changes-plan."},
+                {"name": "--confirm", "required": True, "description": "Confirm the planned writes."},
+                {"name": "--confirm-impact", "required": False, "description": "Additionally confirm delete, move, replacement, or rebind impact."},
+            ],
+            "example": "licos-platform uns changes-apply --file UNS.change.json --document-hash <documentHash> --plan-hash <planHash> --confirm --confirm-impact",
+        },
+        "node-update": {
+            "description": "Build and plan one supported node metadata update; this command never applies it.",
+            "parameters": [
+                {"name": "--path / --node-code", "required": True, "description": "Exactly one project-local target locator."},
+                {"name": "--set-json", "required": True, "description": "Supported node fields to replace."},
+            ],
+            "example": "licos-platform uns node-update --path project:/LINE_1/TEMP_1 --set-json '{\"name\":\"炉温\"}'",
+        },
+        "node-move": {
+            "description": "Build and plan one project-local node move; this command never applies it.",
+            "parameters": [
+                {"name": "--path / --node-code", "required": True, "description": "Exactly one target locator."},
+                {"name": "--parent-path / --parent-node-code", "required": True, "description": "Exactly one destination locator."},
+            ],
+            "example": "licos-platform uns node-move --node-code TEMP_1 --parent-path project:/LINE_2",
+        },
+        "point-rebind": {
+            "description": "Build and plan rebinding one point to one exact existing collection point; this command never applies it.",
+            "parameters": [
+                {"name": "--path / --node-code", "required": True, "description": "Exactly one point target locator."},
+                {"name": "--selector-json", "required": True, "description": "Exact tagCode, taskName, and protocol selector."},
+                {"name": "--field-mappings-json", "required": False, "description": "Optional field mapping array."},
+            ],
+            "example": "licos-platform uns point-rebind --node-code TEMP_1 --selector-json '{\"tagCode\":\"T1\",\"taskName\":\"OPC采集\",\"protocol\":\"opcua\"}'",
+        },
+        "directory-create": {
+            "description": "Build and plan creating one project-local grouping directory; this command never applies it.",
+            "parameters": [
+                {"name": "--parent-path / --parent-node-code", "required": True, "description": "Exactly one parent locator."},
+                {"name": "--node-json", "required": True, "description": "Directory name, stable code, and optional metadata."},
+            ],
+            "example": "licos-platform uns directory-create --parent-path project:/ --node-json '{\"name\":\"一号产线\",\"code\":\"LINE_1\"}'",
+        },
+        "connection-update": {
+            "description": "生成并规划一个当前项目托管采集连接的增量修改，不直接执行写入。",
+            "parameters": [
+                {"name": "--selector-json", "required": True, "description": "精确的 name、protocol 选择器。"},
+                {"name": "--set-json", "required": True, "description": "name、credentialRef 或 configPatch。"},
+                {"name": "--output", "required": False, "description": "在项目目录内保存生成的 UNSChangeSet。"},
+            ],
+            "example": "licos-platform uns connection-update --selector-json '{\"name\":\"一号PLC\",\"protocol\":\"modbus-tcp\"}' --set-json '{\"configPatch\":{\"host\":\"10.0.0.2\"}}' --output UNS.change.json",
+        },
+        "collection-task-update": {
+            "description": "生成并规划一个当前项目托管采集任务的增量修改，不直接执行写入。",
+            "parameters": [
+                {"name": "--selector-json", "required": True, "description": "精确的 name、protocol、connectionName 选择器。"},
+                {"name": "--set-json", "required": True, "description": "name、pollIntervalMs、enabled 或 configPatch。"},
+                {"name": "--output", "required": False, "description": "在项目目录内保存生成的 UNSChangeSet。"},
+            ],
+            "example": "licos-platform uns collection-task-update --selector-json '{\"name\":\"温度采集\",\"protocol\":\"modbus-tcp\",\"connectionName\":\"一号PLC\"}' --set-json '{\"pollIntervalMs\":2000}' --output UNS.change.json",
+        },
+        "point-config-update": {
+            "description": "生成并规划一个当前项目托管采集点位配置的增量修改，不改变点位编码和所属任务。",
+            "parameters": [
+                {"name": "--selector-json", "required": True, "description": "精确的 tagCode、taskName、protocol 选择器。"},
+                {"name": "--set-json", "required": True, "description": "点位通用字段或协议 addressPatch。"},
+                {"name": "--output", "required": False, "description": "在项目目录内保存生成的 UNSChangeSet。"},
+            ],
+            "example": "licos-platform uns point-config-update --selector-json '{\"tagCode\":\"TEMP_01\",\"taskName\":\"温度采集\",\"protocol\":\"modbus-tcp\"}' --set-json '{\"addressPatch\":{\"address\":\"40002\"}}' --output UNS.change.json",
+        },
+        "finalize": {
             "description": "Validate and atomically install a candidate as project-root UNS.json, revalidate it, and return a read-only plan.",
             "parameters": [{"name": "--file", "required": True, "description": "Candidate JSON file inside LICOS_PROJECT_PATH."}],
             "example": "licos-platform uns finalize --file .UNS.json.candidate",
@@ -767,11 +767,116 @@ UNS_HELP = {
 }
 
 
-HELP_TOPICS = {
+INDUSTRIAL_HELP = {
+    "topic": "industrial",
+    "description": "Project-scoped direct collection and video integration without creating UNS nodes.",
+    "runtime": RUNTIME_ENV,
+    "rules": [
+        "Use only when the user explicitly requests direct collector access or explicitly says not to create UNS.",
+        "CLI and SDK call platform APIs; never request or expose IOTDATA API keys or MQTT credentials.",
+        "Search before create. Update and delete require the versionHash returned by resource-get/search.",
+        "Apply requires reviewed documentHash and planHash. Delete also requires --confirm-impact.",
+        "Realtime defaults to WebSocket; MQTT must be selected explicitly. Point control defaults to HTTP; MQTT must be selected explicitly.",
+        "Transport failures do not silently switch to another transport.",
+    ],
+    "resourceTypes": [
+        "edgeAgent (read-only)",
+        "connection",
+        "collectionTask",
+        "collectionPoint",
+        "videoEdge",
+        "videoGateway",
+        "videoDevice",
+        "videoChannel",
+    ],
+    "commands": {
+        "protocol-schema": {
+            "description": "Get required and default fields for one collection protocol.",
+            "parameters": [{"name": "protocol", "required": True, "description": "Protocol code."}],
+            "example": "licos-platform industrial protocol-schema modbus-tcp",
+        },
+        "resource-search": {
+            "description": "Search project-managed or enterprise collection/video resources.",
+            "parameters": [
+                {"name": "--resource-type", "required": True, "description": "Allowlisted resource type."},
+                {"name": "--scope", "required": False, "description": "project or enterprise."},
+                {"name": "--protocol", "required": False, "description": "Collection protocol filter."},
+                {"name": "--keyword", "required": False, "description": "Name/code/address keyword."},
+                {"name": "--selector-json", "required": False, "description": "Exact field selector object."},
+            ],
+            "example": "licos-platform industrial resource-search --resource-type collectionPoint --scope enterprise --keyword TEMP",
+        },
+        "resource-get": {
+            "description": "Get one resource, writable state, and concurrency versionHash.",
+            "parameters": [
+                {"name": "--resource-type", "required": True, "description": "Allowlisted resource type."},
+                {"name": "--resource-id", "required": True, "description": "Resource ID."},
+            ],
+            "example": "licos-platform industrial resource-get --resource-type collectionPoint --resource-id point-id",
+        },
+        "changes-validate / changes-plan / changes-apply": {
+            "description": "Validate, review, and apply an IndustrialChangeSet JSON file.",
+            "parameters": [
+                {"name": "--file", "required": True, "description": "IndustrialChangeSet JSON file."},
+                {"name": "--document-hash / --plan-hash", "required": True, "description": "Required only by apply."},
+                {"name": "--confirm", "required": True, "description": "Required only by apply."},
+                {"name": "--confirm-impact", "required": False, "description": "Required when the plan contains delete impact."},
+            ],
+            "example": "licos-platform industrial changes-plan --file ./industrial.change.json",
+        },
+        "resource-create / resource-update / resource-delete": {
+            "description": "Generate and plan one operation; these commands do not apply writes.",
+            "parameters": [
+                {"name": "--resource-type", "required": True, "description": "Allowlisted resource type."},
+                {"name": "--spec-json / --set-json", "required": False, "description": "Create or update fields."},
+                {"name": "--resource-id / --version-hash", "required": False, "description": "Required by update/delete."},
+                {"name": "--output", "required": False, "description": "Write the generated ChangeSet under LICOS_PROJECT_PATH."},
+            ],
+            "example": "licos-platform industrial resource-update --resource-type collectionPoint --resource-id point-id --version-hash HASH --set-json '{\"name\":\"炉温\"}'",
+        },
+        "realtime-config": {
+            "description": "Build the platform WebSocket URL and subscribe message for application code.",
+            "parameters": [
+                {"name": "--point-id / --tag-code", "required": True, "description": "At least one selector; repeatable."},
+                {"name": "--transport", "required": False, "description": "auto/websocket defaults to WebSocket; mqtt is explicit."},
+            ],
+            "example": "licos-platform industrial realtime-config --point-id point-id --transport websocket",
+        },
+        "point-current / point-history": {
+            "description": "Read current or historical point values.",
+            "parameters": [{"name": "point_id", "required": True, "description": "Collection point ID."}],
+            "example": "licos-platform industrial point-current point-id",
+        },
+        "point-write": {
+            "description": "Dry-run or control a writable project-managed point.",
+            "parameters": [
+                {"name": "point_id", "required": True, "description": "Collection point ID."},
+                {"name": "--value-json", "required": True, "description": "JSON scalar/object value."},
+                {"name": "--reason / --ticket", "required": True, "description": "Audit reason and ticket."},
+                {"name": "--transport", "required": False, "description": "auto/http defaults to HTTP; mqtt is explicit."},
+                {"name": "--dry-run / --confirm", "required": True, "description": "One safety mode is required."},
+            ],
+            "example": "licos-platform industrial point-write point-id --value-json 80 --reason 调试 --ticket T-1 --confirm",
+        },
+        "video-stream / video-start / video-stop": {
+            "description": "Get playback options or explicitly start/stop a project-managed video preview.",
+            "parameters": [
+                {"name": "channel_id", "required": True, "description": "Video channel ID."},
+                {"name": "--protocol", "required": False, "description": "Start defaults to http-flv."},
+                {"name": "--confirm", "required": True, "description": "Required by start/stop."},
+            ],
+            "example": "licos-platform industrial video-start channel-id --protocol http-flv --confirm",
+        },
+    },
+}
+
+
+HELP_TOPICS = {
     "storage": STORAGE_HELP,
     "database": DATABASE_HELP,
     "knowledge": KNOWLEDGE_HELP,
-    "oauth": OAUTH_HELP,
+    "oauth": OAUTH_HELP,
+    "industrial": INDUSTRIAL_HELP,
     "uns": UNS_HELP,
 }