add cli docs and change commands

hiroki0525 · Nov 29, 2023 · 879ba6e · 879ba6e
1 parent 8f0df63
commit 879ba6e
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 5 deletions.
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -25,15 +25,48 @@ Today's My Tasks
 Finally, please execute the following command.
 
 ```bash
-npx --package=@dandori/cli -- dandori-miro your_tasks.txt -b your_miro_board_id
-yarn dlx -p @dandori/cli dandori-miro your_tasks.txt -b your_miro_board_id
-pnpm --package=@dandori/cli dlx dandori-miro your_tasks.txt -b your_miro_board_id
+npx --package=@dandori/cli -- miro your_tasks.txt -b your_miro_board_id
+yarn dlx -p @dandori/cli miro your_tasks.txt -b your_miro_board_id
+pnpm --package=@dandori/cli dlx miro your_tasks.txt -b your_miro_board_id
 ```
 
 ## Requirements
 
 * Please see [@dandori/core](../core/README.md) and [@dandori/ui](../ui/README.md) before using `@dandori/cli`.
 
+## Commands
+
+### core
+
+This command is to execute `generateDandoriTasks` of `@dandori/core`.
+
+```bash
+% pnpm --package=@dandori/cli dlx core -h
+Options:
+  -V, --version                                    output the version number
+  -e, --env-file <env-file>                        env file path
+  -m, --model <model>                              Chat GPT model which supports function_calling
+  -o, --optional-task-props <optional-task-props>  optional output task props which delimiter is a comma
+  -h, --help                                       display help for command
+```
+
+### miro
+
+This command is to execute `generateDandoriMiroCards` of `@dandori/ui`.
+
+```bash
+% pnpm --package=@dandori/cli dlx miro -h
+
+Options:
+  -V, --version                                    output the version number
+  -e, --env-file <env-file>                        env file path
+  -m, --model <model>                              Chat GPT model which supports function_calling
+  -o, --optional-task-props <optional-task-props>  optional output task props which delimiter is a comma
+  -a, --app-card
+  -b, --board-id <board-id>
+  -h, --help                                       display help for command
+```
+
 ## Supported External APIs
 
 * [Miro](https://miro.com/)
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -24,8 +24,8 @@
     "dev:miro": "tsx src/miro/cli.ts"
   },
   "bin": {
-    "dandori": "./dist/core/cli.js",
-    "dandori-miro": "./dist/miro/cli.js"
+    "core": "./dist/core/cli.js",
+    "miro": "./dist/miro/cli.js"
   },
   "keywords": [],
   "author": "Hiroki Miyaji",