hap-cli 0.5.0__py3-none-any.whl

hap_cli/skills/SKILL.md

@@ -0,0 +1,383 @@
+---
+name: hap-cli
+description: CLI harness for MingDAO HAP (明道云) enterprise no-code platform
+version: 0.5.0
+software: hap
+platform: cross-platform
+auth: md_pss_id session token (browser login or manual)
+api_protocol: REST POST /api/{Controller}/{Action}
+install: pip install hap-cli
+binary: hap
+---
+
+# hap-cli
+
+CLI harness for **MingDAO HAP** (明道云), an enterprise no-code/low-code platform.
+Enables programmatic management of applications, worksheets, records, workflows, nodes, approvals, roles, AI assistants, plugins, contacts, departments, groups, chats, posts, calendars, custom pages, and option sets.
+
+## Command Groups
+
+### config - Server Configuration & Authentication
+```bash
+hap config login [SERVER]     # Browser login (mingdao/nocoly/self-hosted URL)
+hap config set --server URL --token TOKEN [--app-id ID] [--project-id ID]
+hap config show
+hap config whoami             # Show current logged-in user
+hap config logout             # Clear saved token
+```
+
+### app - Application Management
+```bash
+hap app list --project-id PID [--keyword K]
+hap app info APP_ID
+hap app worksheets APP_ID
+```
+
+### worksheet - Worksheet Operations
+```bash
+hap worksheet info WS_ID [--app-id ID]
+hap worksheet fields WS_ID [--app-id ID]
+hap worksheet views WS_ID [--app-id ID]
+```
+
+### record - Record CRUD
+```bash
+hap record list WS_ID [--view-id V] [--page-size N] [--keywords K]
+hap record get WS_ID ROW_ID
+hap record create WS_ID -f CID=VAL [-f ...]
+hap record update WS_ID ROW_ID -f CID=VAL [-f ...]
+hap record delete WS_ID ROW_ID1 [ROW_ID2 ...] [--yes]
+```
+
+### workflow - Process Lifecycle
+```bash
+hap workflow list APP_ID [--keyword K]
+hap workflow get PROCESS_ID
+hap workflow create --company-id CID --name N [--app-id A] [--type 1]
+hap workflow update PROCESS_ID [--name N] [--desc D]
+hap workflow delete PROCESS_ID [--yes]
+hap workflow copy PROCESS_ID --name N [--sub-process]
+hap workflow move PROCESS_ID TARGET_APP_ID
+hap workflow publish PROCESS_ID [--disable]
+hap workflow rollback PROCESS_ID [--yes]
+hap workflow history PROCESS_ID
+hap workflow config-get PROCESS_ID
+hap workflow config-set PROCESS_ID --config '{"allowRevoke":true}'
+hap workflow trigger PROCESS_ID [--source-id ROW_ID]
+hap workflow trigger-pbp PROCESS_ID --app-id A
+hap workflow groups APP_ID
+hap workflow stats --company-id CID
+```
+
+### node - Node Management
+```bash
+hap node types                    # Show all node types and action IDs
+hap node list PROCESS_ID
+hap node get PROCESS_ID NODE_ID [--type 4]
+hap node add PROCESS_ID --type 6 [--name N] [--after NODE_ID] [--action-id 1]
+hap node delete PROCESS_ID NODE_ID [--yes]
+hap node rename PROCESS_ID NODE_ID --name N
+hap node desc PROCESS_ID NODE_ID [--desc D] [--alias A]
+hap node save PROCESS_ID NODE_ID --type 4 --config '{...}'
+hap node controls PROCESS_ID NODE_ID --app-id WS_ID  # Get worksheet fields for node config
+# Data processing nodes:
+hap node save-action PID NID -a 1 --app-id WS [-f '[{fieldId,type,fieldValue}]'] [-s SRC_NID]
+hap node save-action PID NID -a 2 --app-id WS -s SRC_NID [-f '[...]']  # Edit record
+hap node save-action PID NID -a 3 --app-id WS -s SRC_NID               # Delete record
+hap node save-search PID NID -a 406 --app-id WS [--condition '[...]'] [--not-found 0|1|2]
+hap node save-search PID NID -a 421 --app-id WS [-f '[...]']           # Find & update
+hap node save-search PID NID -a 422 --app-id WS                        # Find & delete
+hap node save-get-more PID NID -a 400 --app-id WS [--condition '[...]'] [--limit '{...}']
+hap node save-get-more PID NID -a 412 --app-id WS [-f '[...]']         # Batch update
+hap node save-get-more PID NID -a 413 --app-id WS                      # Batch delete
+# Testing:
+hap node test-code PROCESS_ID NODE_ID --code 'return 1+1' [--input '[...]']
+hap node test-webhook PROCESS_ID NODE_ID --url URL [--method GET] [--body '{}']
+hap node test-ai PROCESS_ID NODE_ID --prompt 'Summarize' [--model M]
+# Utilities:
+hap node form-property PROCESS_ID NODE_ID
+hap node sub-processes PROCESS_ID
+hap node json-to-controls --json-str '{"key":"val"}'
+hap node code-templates [--keyword K]
+hap node create-code-template --name N --code C
+```
+
+### instance - Approval & Todo
+```bash
+hap instance todo-count
+hap instance todo [--type -1] [--keyword K] [--process-id P]
+hap instance get INSTANCE_ID [--work-id W]
+hap instance operations INSTANCE_ID
+hap instance op-history INSTANCE_ID
+hap instance approve INSTANCE_ID [--work-id W] [--opinion O]
+hap instance reject INSTANCE_ID [--opinion O] [--back-to NODE_ID]
+hap instance forward INSTANCE_ID --to USER_ID [--opinion O]
+hap instance sign INSTANCE_ID --to USER_ID [--before/--after]
+hap instance submit INSTANCE_ID [--work-id W]
+hap instance revoke INSTANCE_ID
+hap instance urge INSTANCE_ID
+hap instance terminate INSTANCE_ID [--yes]
+hap instance retry INSTANCE_ID
+hap instance restart INSTANCE_ID
+hap instance history [--process-id P] [--status 1] [--keyword K]
+hap instance history-detail INSTANCE_ID
+hap instance batch --action 4 [--select ID1 -s ID2]
+```
+
+### role - Role Management
+```bash
+hap role list APP_ID
+hap role create APP_ID --name N [--permission 10]
+hap role delete APP_ID ROLE_ID [--move-to R] [--yes]
+hap role add-member APP_ID ROLE_ID -u UID [-u ...]
+hap role remove-member APP_ID ROLE_ID -u UID [-u ...]
+hap role permissions APP_ID ROLE_ID
+hap role set-permissions APP_ID ROLE_ID --config '{...}'
+hap role rename APP_ID ROLE_ID --name N
+hap role apply APP_ID ROLE_ID [--note N]
+hap role approve APP_ID ROLE_ID --account-id UID
+hap role reject APP_ID ROLE_ID --account-id UID
+hap role pending APP_ID ROLE_ID
+```
+
+### optionset - Option Set Management
+```bash
+hap optionset list --app-id APP_ID
+hap optionset get COLLECT_ID
+hap optionset save --app-id APP_ID --name N --options '[{...}]'
+hap optionset delete COLLECT_ID [--yes]
+hap optionset move COLLECT_ID --app-id TARGET_APP_ID
+```
+
+### page - Custom Page Management
+```bash
+hap page copy APP_ID PAGE_ID --name N
+hap page authorize APP_ID PAGE_ID --role-id ROLE_ID
+hap page permissions APP_ID PAGE_ID
+hap page edit-permission APP_ID PAGE_ID AUTH_ID --status 0|1
+hap page delete-permission APP_ID PAGE_ID AUTH_ID [--yes]
+hap page component-types
+```
+
+### contact - Address Book & Contacts
+```bash
+hap contact search KEYWORDS [--project-id PID]
+hap contact get ACCOUNT_ID
+hap contact friends
+hap contact add-friend ACCOUNT_ID
+hap contact remove-friend ACCOUNT_ID [--yes]
+hap contact friend-requests
+hap contact accept-friend ACCOUNT_ID
+hap contact reject-friend ACCOUNT_ID
+```
+
+### department - Department Management
+```bash
+hap department list --project-id PID [--parent-id DID]
+hap department tree --project-id PID DEPT_ID
+hap department info DEPT_ID
+hap department create --project-id PID --name N [--parent-id DID]
+hap department update DEPT_ID [--name N]
+hap department delete --project-id PID -d DID [-d ...]
+hap department members --project-id PID DEPT_ID
+hap department search --project-id PID KEYWORDS
+hap department move DEPT_ID --target-id TARGET_DEPT_ID
+```
+
+### post - Feed & Post Management
+```bash
+hap post list --project-id PID [--page-size N]
+hap post get POST_ID
+hap post create --project-id PID --type 1 --message TEXT
+hap post update POST_ID --message TEXT
+hap post delete POST_ID [--yes]
+hap post comment POST_ID --message TEXT
+hap post comments POST_ID
+hap post like POST_ID
+hap post top POST_ID [--remove]
+```
+
+### calendar - Calendar & Schedule
+```bash
+hap calendar list --start START_DATE --end END_DATE [--project-id PID]
+hap calendar get CALENDAR_ID
+hap calendar create --name N --start START_DATE --end END_DATE
+hap calendar update CALENDAR_ID [--name N] [--start S] [--end E]
+hap calendar delete CALENDAR_ID [--yes]
+hap calendar add-member CALENDAR_ID -m MEMBER_ID [-m ...]
+hap calendar remove-member CALENDAR_ID MEMBER_ID
+hap calendar categories
+```
+
+### chat - Chat & Messaging
+```bash
+hap chat list
+hap chat send -t ACCOUNT_ID [-t ...] --message TEXT
+hap chat send-file GROUP_ID --file PATH
+hap chat send-card GROUP_ID --card '{...}'
+hap chat group-info GROUP_ID
+hap chat group-files GROUP_ID
+```
+
+### group - Group Management
+```bash
+hap group list --project-id PID [--page-size N]
+hap group info GROUP_ID
+hap group create --project-id PID --name N [--about A] [-m UID ...]
+hap group delete GROUP_ID [--yes]
+hap group members GROUP_ID
+hap group remove-member GROUP_ID ACCOUNT_ID
+hap group update GROUP_ID [--name N] [--about A]
+```
+
+### ai - AI Assistant & Service
+```bash
+hap ai assistants --project-id PID
+hap ai assistant-get ASSISTANT_ID
+hap ai assistant-create --config '{...}'
+hap ai assistant-delete ASSISTANT_ID [--yes]
+hap ai assistant-status ASSISTANT_ID --status 1|0
+hap ai knowledge-list --project-id PID
+hap ai knowledge-get KB_ID
+hap ai knowledge-create --config '{...}'
+hap ai knowledge-delete KB_ID [--yes]
+hap ai chatbot-config PROCESS_ID
+hap ai chatbot-save PROCESS_ID --config '{...}'
+hap ai service-status --project-id PID
+hap ai models --project-id PID
+```
+
+### plugin - Plugin Management
+```bash
+hap plugin list --project-id PID
+hap plugin get PLUGIN_ID
+hap plugin create --project-id PID --name N [--desc D]
+hap plugin edit PLUGIN_ID [--name N] [--desc D]
+hap plugin delete PLUGIN_ID [--yes]
+hap plugin release PLUGIN_ID
+hap plugin rollback PLUGIN_ID VERSION_ID
+hap plugin history PLUGIN_ID
+```
+
+### repl - Interactive Mode
+```bash
+hap repl
+```
+
+## JSON Output
+
+Add `--json` before any command group:
+```bash
+hap --json workflow list APP_ID
+hap --json instance todo
+hap --json node get PROCESS_ID NODE_ID
+```
+
+## Node Types Reference
+
+| Type | Name | Description |
+|------|------|-------------|
+| 0 | Start | Start event |
+| 1 | Branch | Conditional branch/gateway |
+| 2 | BranchItem | Branch condition item |
+| 3 | Fill | Fill-in form task |
+| 4 | Approval | Approval task |
+| 5 | CC | CC notification |
+| **6** | **Action** | **Data processing: add/edit/delete record** |
+| **7** | **Search** | **Get single record** |
+| 8 | WebHook | HTTP request |
+| 9 | Formula | Formula/calculation |
+| 10 | Message | SMS notification |
+| 11 | Email | Email notification |
+| 12 | Delay | Timer/delay |
+| **13** | **GetMoreRecord** | **Get multiple records / batch ops** |
+| 14 | Code | Code block (JS/Python) |
+| 15 | Link | Get record link |
+| 16 | SubProcess | Sub-process call |
+| 17 | Push | UI push notification |
+| 18 | File | Print/PDF generation |
+| 19 | Template | Template message |
+| 20 | PBP | Packaged Business Process |
+| 21 | JSONParse | JSON parser |
+| 22 | Authentication | API auth |
+| 25 | API | Integrated API call |
+| 26 | ApprovalProcess | Initiate approval |
+| 27 | Notice | Internal notice |
+| 28 | Snapshot | Data snapshot |
+| 29 | Loop | Loop processing |
+| 31 | AIGC | AI text/object generation |
+| 32 | Plugin | Plugin call |
+| 33 | Agent | AI Agent |
+
+## Action IDs (for data processing nodes)
+
+| Action | ID | Node | Description |
+|--------|-----|------|-------------|
+| ADD_RECORD | 1 | 6 | Add single record |
+| EDIT_RECORD | 2 | 6 | Edit record fields |
+| DELETE_RECORD | 3 | 6 | Delete record |
+| RELATION | 20 | 6 | Get related record |
+| WORKSHEET_FIND | 406 | 7 | Find one from worksheet |
+| BATCH_FIND | 407 | 7 | Find one from multi-records |
+| RECORD_UPDATE | 421 | 7 | Find and update |
+| RECORD_DELETE | 422 | 7 | Find and delete |
+| FROM_WORKSHEET | 400 | 13 | Get multi from worksheet |
+| FROM_RECORD | 401 | 13 | Get multi from relation |
+| BATCH_UPDATE | 412 | 13 | Batch update records |
+| BATCH_DELETE | 413 | 13 | Batch delete records |
+
+## Instance Status Reference
+
+| Status | Meaning |
+|--------|---------|
+| 1 | Running |
+| 2 | Completed |
+| 3 | Rejected |
+| 4 | Failed/Terminated |
+
+## Todo Type Reference
+
+| Type | Meaning |
+|------|---------|
+| -1 | All pending |
+| 0 | Initiated by me |
+| 3 | Pending fill |
+| 4 | Pending approval |
+| 5 | Pending view |
+
+## Agent Usage Notes
+
+- **Authentication**: Use `config login` for browser-based login, or `config set --token` for manual token. Supports mingdao, nocoly, and self-hosted servers.
+- **Workflow lifecycle**: create -> add nodes -> save node config -> publish -> trigger.
+- **Node config**: Use `node get` to see current config, then modify and `node save`.
+- **Testing nodes**: Use `test-code`, `test-webhook`, or `test-ai` before publishing.
+- **Approvals**: Use `instance todo` to find tasks, then `approve`/`reject`/`forward`.
+- **Batch operations**: `instance batch --action 4` for batch approve, `5` for batch reject.
+
+## Example: Build and Deploy a Workflow
+
+```bash
+# 1. Create workflow
+hap --json workflow create -c COMPANY_ID -n "Auto Approval" -a APP_ID
+
+# 2. Get process nodes (has start node by default)
+hap --json node list PROCESS_ID
+
+# 3. Add approval node after start
+hap --json node add PROCESS_ID --type 4 --name "Manager Approval" --after START_NODE_ID
+
+# 4. Configure approval node
+hap node save PROCESS_ID NODE_ID --type 4 --config '{"accounts":[{"accountId":"MGR_USER_ID"}]}'
+
+# 5. Publish workflow
+hap workflow publish PROCESS_ID
+
+# 6. Trigger
+hap --json workflow trigger PROCESS_ID --source-id ROW_ID
+
+# 7. Check pending approvals
+hap --json instance todo --type 4
+
+# 8. Approve
+hap instance approve INSTANCE_ID --opinion "Approved"
+```

hap_cli/tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for hap-cli harness."""