From 2744a27e7d6b671a2ea2cec7142a2819a81095f6 Mon Sep 17 00:00:00 2001 From: Thibault Pensec Date: Thu, 18 Jun 2026 12:52:44 +0200 Subject: [PATCH 1/3] feat: add symphony-bdk-cli module MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Introduces a new `symphony-bdk-cli` Gradle module — a command-line interface built on top of symphony-bdk-core using picocli. Provides sub-commands for health checks, datafeed monitoring, message operations, stream management, and user lookups. Includes design docs, OpenSpec change artifacts, and documentation updates. --- .claude/commands/opsx/apply.md | 152 +++++++++ .claude/commands/opsx/archive.md | 157 ++++++++++ .claude/commands/opsx/explore.md | 173 +++++++++++ .claude/commands/opsx/propose.md | 106 +++++++ .claude/skills/openspec-apply-change/SKILL.md | 156 ++++++++++ .../skills/openspec-archive-change/SKILL.md | 114 +++++++ .claude/skills/openspec-explore/SKILL.md | 288 ++++++++++++++++++ .claude/skills/openspec-propose/SKILL.md | 110 +++++++ README.md | 15 + docs/cli.md | 160 ++++++++++ docs/index.md | 44 +-- gradle/wrapper/gradle-wrapper.properties | 2 +- openspec/changes/add-bdk-cli/.openspec.yaml | 2 + openspec/changes/add-bdk-cli/design.md | 96 ++++++ openspec/changes/add-bdk-cli/proposal.md | 55 ++++ .../changes/add-bdk-cli/specs/cli/spec.md | 151 +++++++++ openspec/changes/add-bdk-cli/tasks.md | 36 +++ openspec/config.yaml | 20 ++ settings.gradle | 3 + symphony-bdk-bom/build.gradle | 2 + symphony-bdk-cli/README.md | 24 ++ symphony-bdk-cli/build.gradle | 46 +++ .../java/com/symphony/bdk/cli/BdkCli.java | 136 +++++++++ .../symphony/bdk/cli/command/BaseCommand.java | 44 +++ .../bdk/cli/command/ContainerCommand.java | 19 ++ .../bdk/cli/command/WhoamiCommand.java | 17 ++ .../cli/command/datafeed/DatafeedCommand.java | 15 + .../command/datafeed/DatafeedReadCommand.java | 87 ++++++ .../command/health/HealthCheckCommand.java | 17 ++ .../bdk/cli/command/health/HealthCommand.java | 15 + .../cli/command/message/MessageCommand.java | 17 ++ .../command/message/MessageGetCommand.java | 27 ++ .../command/message/MessageListCommand.java | 49 +++ .../command/message/MessageSendCommand.java | 29 ++ .../bdk/cli/command/stream/StreamCommand.java | 17 ++ .../cli/command/stream/StreamGetCommand.java | 27 ++ .../cli/command/stream/StreamListCommand.java | 25 ++ .../command/stream/StreamMembersCommand.java | 21 ++ .../bdk/cli/command/user/UserCommand.java | 16 + .../bdk/cli/command/user/UserGetCommand.java | 51 ++++ .../cli/command/user/UserSearchCommand.java | 34 +++ .../BdkCliExecutionExceptionHandler.java | 73 +++++ .../bdk/cli/internal/DurationConverter.java | 50 +++ .../com/symphony/bdk/cli/internal/Json.java | 50 +++ .../bdk/cli/internal/NotFoundException.java | 17 ++ .../src/main/resources/logback.xml | 31 ++ .../symphony/bdk/cli/BdkCliWiringTest.java | 54 ++++ .../com/symphony/bdk/cli/CliTestBase.java | 40 +++ .../com/symphony/bdk/cli/CommandTest.java | 181 +++++++++++ .../symphony/bdk/cli/DatafeedReadTest.java | 49 +++ .../com/symphony/bdk/cli/ExitCodeTest.java | 115 +++++++ .../com/symphony/bdk/cli/JsonOutputTest.java | 65 ++++ .../bdk/core/config/BdkConfigParser.java | 2 +- 53 files changed, 3280 insertions(+), 22 deletions(-) create mode 100644 .claude/commands/opsx/apply.md create mode 100644 .claude/commands/opsx/archive.md create mode 100644 .claude/commands/opsx/explore.md create mode 100644 .claude/commands/opsx/propose.md create mode 100644 .claude/skills/openspec-apply-change/SKILL.md create mode 100644 .claude/skills/openspec-archive-change/SKILL.md create mode 100644 .claude/skills/openspec-explore/SKILL.md create mode 100644 .claude/skills/openspec-propose/SKILL.md create mode 100644 docs/cli.md create mode 100644 openspec/changes/add-bdk-cli/.openspec.yaml create mode 100644 openspec/changes/add-bdk-cli/design.md create mode 100644 openspec/changes/add-bdk-cli/proposal.md create mode 100644 openspec/changes/add-bdk-cli/specs/cli/spec.md create mode 100644 openspec/changes/add-bdk-cli/tasks.md create mode 100644 openspec/config.yaml create mode 100644 symphony-bdk-cli/README.md create mode 100644 symphony-bdk-cli/build.gradle create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/BdkCli.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/BaseCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/ContainerCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/WhoamiCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/datafeed/DatafeedCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/datafeed/DatafeedReadCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/health/HealthCheckCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/health/HealthCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/message/MessageCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/message/MessageGetCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/message/MessageListCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/message/MessageSendCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/stream/StreamCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/stream/StreamGetCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/stream/StreamListCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/stream/StreamMembersCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/user/UserCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/user/UserGetCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/command/user/UserSearchCommand.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/internal/BdkCliExecutionExceptionHandler.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/internal/DurationConverter.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/internal/Json.java create mode 100644 symphony-bdk-cli/src/main/java/com/symphony/bdk/cli/internal/NotFoundException.java create mode 100644 symphony-bdk-cli/src/main/resources/logback.xml create mode 100644 symphony-bdk-cli/src/test/java/com/symphony/bdk/cli/BdkCliWiringTest.java create mode 100644 symphony-bdk-cli/src/test/java/com/symphony/bdk/cli/CliTestBase.java create mode 100644 symphony-bdk-cli/src/test/java/com/symphony/bdk/cli/CommandTest.java create mode 100644 symphony-bdk-cli/src/test/java/com/symphony/bdk/cli/DatafeedReadTest.java create mode 100644 symphony-bdk-cli/src/test/java/com/symphony/bdk/cli/ExitCodeTest.java create mode 100644 symphony-bdk-cli/src/test/java/com/symphony/bdk/cli/JsonOutputTest.java diff --git a/.claude/commands/opsx/apply.md b/.claude/commands/opsx/apply.md new file mode 100644 index 000000000..ae14f0f5f --- /dev/null +++ b/.claude/commands/opsx/apply.md @@ -0,0 +1,152 @@ +--- +name: "OPSX: Apply" +description: Implement tasks from an OpenSpec change (Experimental) +category: Workflow +tags: [workflow, artifacts, experimental] +--- + +Implement tasks from an OpenSpec change. + +**Input**: Optionally specify a change name (e.g., `/opsx:apply add-auth`). If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes. + +**Steps** + +1. **Select the change** + + If a name is provided, use it. Otherwise: + - Infer from conversation context if the user mentioned a change + - Auto-select if only one active change exists + - If ambiguous, run `openspec list --json` to get available changes and use the **AskUserQuestion tool** to let the user select + + Always announce: "Using change: " and how to override (e.g., `/opsx:apply `). + +2. **Check status to understand the schema** + ```bash + openspec status --change "" --json + ``` + Parse the JSON to understand: + - `schemaName`: The workflow being used (e.g., "spec-driven") + - Which artifact contains the tasks (typically "tasks" for spec-driven, check status for others) + +3. **Get apply instructions** + + ```bash + openspec instructions apply --change "" --json + ``` + + This returns: + - `contextFiles`: artifact ID -> array of concrete file paths (varies by schema) + - Progress (total, complete, remaining) + - Task list with status + - Dynamic instruction based on current state + + **Handle states:** + - If `state: "blocked"` (missing artifacts): show message, suggest using `/opsx:continue` + - If `state: "all_done"`: congratulate, suggest archive + - Otherwise: proceed to implementation + +4. **Read context files** + + Read every file path listed under `contextFiles` from the apply instructions output. + The files depend on the schema being used: + - **spec-driven**: proposal, specs, design, tasks + - Other schemas: follow the contextFiles from CLI output + +5. **Show current progress** + + Display: + - Schema being used + - Progress: "N/M tasks complete" + - Remaining tasks overview + - Dynamic instruction from CLI + +6. **Implement tasks (loop until done or blocked)** + + For each pending task: + - Show which task is being worked on + - Make the code changes required + - Keep changes minimal and focused + - Mark task complete in the tasks file: `- [ ]` → `- [x]` + - Continue to next task + + **Pause if:** + - Task is unclear → ask for clarification + - Implementation reveals a design issue → suggest updating artifacts + - Error or blocker encountered → report and wait for guidance + - User interrupts + +7. **On completion or pause, show status** + + Display: + - Tasks completed this session + - Overall progress: "N/M tasks complete" + - If all done: suggest archive + - If paused: explain why and wait for guidance + +**Output During Implementation** + +``` +## Implementing: (schema: ) + +Working on task 3/7: +[...implementation happening...] +✓ Task complete + +Working on task 4/7: +[...implementation happening...] +✓ Task complete +``` + +**Output On Completion** + +``` +## Implementation Complete + +**Change:** +**Schema:** +**Progress:** 7/7 tasks complete ✓ + +### Completed This Session +- [x] Task 1 +- [x] Task 2 +... + +All tasks complete! You can archive this change with `/opsx:archive`. +``` + +**Output On Pause (Issue Encountered)** + +``` +## Implementation Paused + +**Change:** +**Schema:** +**Progress:** 4/7 tasks complete + +### Issue Encountered + + +**Options:** +1.