@camunda8/cli 2.0.0-alpha.1 → 2.0.0-alpha.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +72 -5
- package/dist/commands/completion.d.ts +8 -0
- package/dist/commands/completion.d.ts.map +1 -0
- package/dist/commands/completion.js +596 -0
- package/dist/commands/completion.js.map +1 -0
- package/dist/commands/help.d.ts.map +1 -1
- package/dist/commands/help.js +12 -4
- package/dist/commands/help.js.map +1 -1
- package/dist/commands/process-definitions.d.ts +17 -0
- package/dist/commands/process-definitions.d.ts.map +1 -0
- package/dist/commands/process-definitions.js +61 -0
- package/dist/commands/process-definitions.js.map +1 -0
- package/dist/commands/profiles.d.ts +17 -8
- package/dist/commands/profiles.d.ts.map +1 -1
- package/dist/commands/profiles.js +74 -35
- package/dist/commands/profiles.js.map +1 -1
- package/dist/commands/session.js +3 -3
- package/dist/commands/session.js.map +1 -1
- package/dist/config.d.ts +104 -49
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +306 -164
- package/dist/config.js.map +1 -1
- package/dist/index.js +30 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,15 +5,20 @@ A minimal-dependency CLI for Camunda 8 operations built on top of `@camunda8/orc
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
7
|
- **Minimal Dependencies**: Only one runtime dependency (`@camunda8/orchestration-cluster-api`)
|
|
8
|
-
- **Native TypeScript**: Runs directly with Node.js 22.18+ (no compilation needed)
|
|
9
8
|
- **Multi-Tenant Support**: Full support for multi-tenancy across all operations
|
|
10
9
|
- **Profile Management**: Store and manage multiple cluster configurations
|
|
11
10
|
- **Camunda Modeler Integration**: Automatically import and use profiles from Camunda Modeler
|
|
12
11
|
- **Plugin System**: Extend c8ctl with custom commands via npm packages
|
|
13
|
-
- **
|
|
14
|
-
- **
|
|
12
|
+
- **Building Block Deployment**: Automatic prioritization of `*_bb-*` folders during deployment
|
|
13
|
+
- **Watch Mode**: Monitors a folder for changes to `*.{bpmn,dmn,form}` and auto-redeploys
|
|
15
14
|
- **Flexible Output**: Switch between human-readable text and JSON output modes
|
|
16
15
|
|
|
16
|
+
## Beware the 🤖
|
|
17
|
+
|
|
18
|
+
*Full transparency*:
|
|
19
|
+
this cli is also a pilot-coding experiment.
|
|
20
|
+
Guided by humans, the codebase is (mostly) built by your friendly neighborhood LLM, fully dogfooding the Human-in-the-Loop pattern.
|
|
21
|
+
|
|
17
22
|
## Architecture
|
|
18
23
|
|
|
19
24
|
### Core Components
|
|
@@ -71,10 +76,21 @@ c8ctl list pi
|
|
|
71
76
|
# Or using full command name
|
|
72
77
|
c8ctl list process-instances
|
|
73
78
|
|
|
79
|
+
# List process definitions (using alias 'pd')
|
|
80
|
+
c8ctl list pd
|
|
81
|
+
c8ctl list process-definitions
|
|
82
|
+
|
|
74
83
|
# Get process instance by key
|
|
75
84
|
c8ctl get pi 123456
|
|
76
85
|
c8ctl get process-instance 123456
|
|
77
86
|
|
|
87
|
+
# Get process definition by key
|
|
88
|
+
c8ctl get pd 123456
|
|
89
|
+
c8ctl get process-definition 123456
|
|
90
|
+
|
|
91
|
+
# Get process definition XML
|
|
92
|
+
c8ctl get pd 123456 --xml
|
|
93
|
+
|
|
78
94
|
# Create process instance
|
|
79
95
|
c8ctl create pi --bpmnProcessId=myProcess
|
|
80
96
|
c8ctl create process-instance --bpmnProcessId=myProcess
|
|
@@ -85,10 +101,57 @@ c8ctl deploy ./my-process.bpmn
|
|
|
85
101
|
# Deploy current directory
|
|
86
102
|
c8ctl deploy
|
|
87
103
|
|
|
104
|
+
# Watch mode (using alias 'w')
|
|
105
|
+
c8ctl w
|
|
106
|
+
c8ctl watch
|
|
107
|
+
|
|
88
108
|
# Deploy and start process (run)
|
|
89
109
|
c8ctl run ./my-process.bpmn
|
|
90
110
|
```
|
|
91
111
|
|
|
112
|
+
### Shell Completion
|
|
113
|
+
|
|
114
|
+
c8ctl supports shell completion for `bash`, `zsh`, and `fish`. To enable completion:
|
|
115
|
+
|
|
116
|
+
#### Bash
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
# Generate and source completion script
|
|
120
|
+
c8ctl completion bash > ~/.c8ctl-completion.bash
|
|
121
|
+
echo 'source ~/.c8ctl-completion.bash' >> ~/.bashrc
|
|
122
|
+
source ~/.bashrc
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Or for immediate use in the current session:
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
source <(c8ctl completion bash)
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
#### Zsh
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
# Generate and source completion script
|
|
135
|
+
c8ctl completion zsh > ~/.c8ctl-completion.zsh
|
|
136
|
+
echo 'source ~/.c8ctl-completion.zsh' >> ~/.zshrc
|
|
137
|
+
source ~/.zshrc
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Or for immediate use in the current session:
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
source <(c8ctl completion zsh)
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
#### Fish
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
# Generate and install completion script
|
|
150
|
+
c8ctl completion fish > ~/.config/fish/completions/c8ctl.fish
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
Fish will automatically load the completion on next shell start.
|
|
154
|
+
|
|
92
155
|
### Credential Resolution
|
|
93
156
|
|
|
94
157
|
Credentials are resolved in the following order:
|
|
@@ -265,6 +328,7 @@ When plugins are loaded, their commands automatically appear in `c8ctl help` out
|
|
|
265
328
|
### Resource Aliases
|
|
266
329
|
|
|
267
330
|
- `pi` = process-instance(s)
|
|
331
|
+
- `pd` = process-definition(s)
|
|
268
332
|
- `ut` = user-task(s)
|
|
269
333
|
- `inc` = incident(s)
|
|
270
334
|
- `msg` = message
|
|
@@ -277,7 +341,7 @@ c8ctl <verb> <resource> [arguments] [flags]
|
|
|
277
341
|
|
|
278
342
|
**Verbs**: list, get, create, cancel, complete, fail, activate, resolve, publish, correlate, deploy, run, add, remove, use, output
|
|
279
343
|
|
|
280
|
-
**Resources**: process-instance, user-task, incident, job, message, topology, profile, tenant
|
|
344
|
+
**Resources**: process-instance, process-definition, user-task, incident, job, message, topology, profile, tenant
|
|
281
345
|
|
|
282
346
|
## Testing
|
|
283
347
|
|
|
@@ -302,6 +366,9 @@ Integration tests require a running Camunda 8 instance at `http://localhost:8080
|
|
|
302
366
|
|
|
303
367
|
## Development
|
|
304
368
|
|
|
369
|
+
- **Native TypeScript**: Runs directly with Node.js 22.18+ (no compilation needed)
|
|
370
|
+
|
|
371
|
+
|
|
305
372
|
### Project Structure
|
|
306
373
|
|
|
307
374
|
```
|
|
@@ -388,7 +455,7 @@ Modeler profiles are:
|
|
|
388
455
|
|
|
389
456
|
## License
|
|
390
457
|
|
|
391
|
-
|
|
458
|
+
Apache 2.0 - see LICENSE.md
|
|
392
459
|
|
|
393
460
|
## Contributing
|
|
394
461
|
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"completion.d.ts","sourceRoot":"","sources":["../../src/commands/completion.ts"],"names":[],"mappings":"AAAA;;GAEG;AA2jBH;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CA0BnD"}
|