Skip to content

Commit 76ecc64

Browse files
Copilotvobu
andcommitted
docs: update README with all help commands and fix watch help
Co-authored-by: vobu <6573426+vobu@users.noreply.github.com>
1 parent 183af74 commit 76ecc64

File tree

3 files changed

+15
-7
lines changed

3 files changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,21 @@ After installation, the CLI is available as `c8ctl` (or its alias `c8`).
7272
c8ctl help
7373

7474
# Show detailed help for specific commands with all flags
75-
c8ctl help list # Shows all list resources and their flags
76-
c8ctl help get # Shows all get resources and their flags
77-
c8ctl help create # Shows all create resources and their flags
78-
c8ctl help complete # Shows all complete resources and their flags
75+
c8ctl help list # Shows all list resources and their flags
76+
c8ctl help get # Shows all get resources and their flags
77+
c8ctl help create # Shows all create resources and their flags
78+
c8ctl help complete # Shows all complete resources and their flags
79+
c8ctl help await # Shows await command with all flags
80+
c8ctl help search # Shows all search resources and their flags
81+
c8ctl help deploy # Shows deploy command with all flags
82+
c8ctl help run # Shows run command with all flags
83+
c8ctl help watch # Shows watch command with all flags
84+
c8ctl help cancel # Shows cancel command with all flags
85+
c8ctl help resolve # Shows resolve command with all flags
86+
c8ctl help fail # Shows fail command with all flags
87+
c8ctl help activate # Shows activate command with all flags
88+
c8ctl help publish # Shows publish command with all flags
89+
c8ctl help correlate # Shows correlate command with all flags
7990

8091
# Show version
8192
c8ctl --version

src/commands/help.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,6 @@ Description:
573573
574574
Flags:
575575
--profile <name> Use specific profile
576-
--variables <json> Auto-create process instances with variables after deployment
577576
578577
Supported File Types:
579578
- BPMN files (.bpmn)
@@ -585,7 +584,6 @@ Examples:
585584
c8ctl watch ./src Watch ./src directory
586585
c8ctl watch ./src ./forms Watch multiple directories
587586
c8ctl w ./src Use short alias
588-
c8ctl watch ./src --variables='{"test":true}' Auto-create instances with variables
589587
c8ctl watch --profile=dev Watch using specific profile
590588
`.trim());
591589
}

tests/unit/help.test.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,6 @@ describe('Help Module', () => {
288288
assert.ok(output.includes('c8ctl watch'));
289289
assert.ok(output.includes('Watch files'));
290290
assert.ok(output.includes('Alias: w'));
291-
assert.ok(output.includes('--variables'));
292291
});
293292

294293
test('showCommandHelp shows cancel help', () => {

0 commit comments

Comments
 (0)