Skip to content

Commit 01d42fe

Browse files
committed
feat: migrated CLI to commander; CLI improvments; README updated
1 parent 45abed1 commit 01d42fe

17 files changed

+1035
-696
lines changed

README.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Project seeks to eliminate the need of managing nodes dependencies and establish
2020
## Setup
2121

2222
```bash
23-
npm i -g cognigy-hammer
23+
$ npm i -g cognigy-hammer
24+
25+
$ cognigy-hammer create scaffold
2426
```
2527

2628
## Features
@@ -30,14 +32,21 @@ npm i -g cognigy-hammer
3032
- Connections and Nodes are imported automatically.
3133
- Helper function for setting the next node.
3234

33-
## CLI commands
35+
## CLI overview
3436

35-
The following commands should be available after installing the package globally. If they are not, you may need to use `npm exec` / `npx`
3637
```bash
37-
ch.create-project # create a new extension project scaffold
38-
ch.create-node # create a new node in an extension project
39-
ch.delete-node # delete a node from an extension project
40-
ch.create-connection # create a new connection in an extension project
38+
Usage: cognigy-hammer [options] [command]
39+
40+
An extension development suite for CognigyAI.
41+
42+
Options:
43+
-V, --version output the version number
44+
-h, --help display help for command
45+
46+
Commands:
47+
create <entity> Guided way to create a new entity.
48+
delete <entity> Guided way to delete an existing entity.
49+
help [command] display help for command
4150
```
4251

4352
## Standard

demos/create-extension.demo.gif

-433 KB
Loading

demos/create-extension.demo.yml

+170-190
Large diffs are not rendered by default.

demos/create-node.demo.gif

1.32 MB
Loading

demos/create-node.demo.yml

+261-107
Large diffs are not rendered by default.

demos/delete-node.demo.gif

493 KB
Loading

demos/delete-node.demo.yml

+130-56
Large diffs are not rendered by default.

package-lock.json

+21
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+14-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"type": "commonjs",
33
"name": "cognigy-hammer",
44
"description": "An extension development suite for CognigyAI.",
5-
"version": "0.5.0",
5+
"version": "0.6.0",
66
"license": "MIT",
77
"main": "./build/index.js",
88
"types": "./build/index.d.ts",
@@ -14,7 +14,13 @@
1414
"type": "git",
1515
"url": "https://github.com/tgbv/cognigy-hammer.git"
1616
},
17-
"keywords": ["cognigy", "ai", "extension", "development-suite", "cli"],
17+
"keywords": [
18+
"cognigy",
19+
"ai",
20+
"extension",
21+
"development-suite",
22+
"cli"
23+
],
1824
"files": [
1925
"build",
2026
"templates",
@@ -32,6 +38,7 @@
3238
"create:node": "npx ts-node ./src/commands/create:node.ts",
3339
"create:connection": "npx ts-node ./src/commands/create:connection.ts",
3440
"delete:node": "npx ts-node ./src/commands/delete:node.ts",
41+
"cw": "npx ts-node ./src/commands/commanderWrapper",
3542
"transpile": "npx jest --coverage --passWithNoTests ./src && npx tsc",
3643
"local:build": "npm run transpile && npm pack && npm i --global cognigy-hammer-*"
3744
},
@@ -41,19 +48,22 @@
4148
"ch.create-extension": "./build/commands/create:scaffold.js",
4249
"ch.create-connection": "./build/commands/create:connection.js",
4350
"ch.create-node": "./build/commands/create:node.js",
44-
"ch.delete-node": "./build/commands/delete:node.js"
51+
"ch.delete-node": "./build/commands/delete:node.js",
52+
"cognigy-hammer": "./build/commands/commanderWrapper.js"
4553
},
4654
"devDependencies": {
55+
"@types/commander": "^2.12.0",
4756
"@types/jest": "^29.5.5",
4857
"@types/node": "^20.8.6",
4958
"@types/prompts": "^2.4.5",
5059
"ts-jest": "^29.1.1"
5160
},
5261
"dependencies": {
5362
"@cognigy/extension-tools": "^0.15.1",
54-
"node-console-colors": "^1.1.5",
63+
"commander": "^12.1.0",
5564
"detect-ts-node": "^1.0.5",
5665
"handlebars": "^4.7.8",
66+
"node-console-colors": "^1.1.5",
5767
"prompts": "^2.4.2"
5868
}
5969
}

0 commit comments

Comments
 (0)