|
1 | 1 | --- |
2 | 2 | name: pipedrive-new-app |
3 | 3 | description: Scaffold a new Pipedrive Marketplace integration project with OAuth, database, and optional App Extensions. Use when the developer wants to start a new Pipedrive app from scratch. |
4 | | -allowed-tools: [Bash] |
| 4 | +allowed-tools: [Bash, AskUserQuestion] |
5 | 5 | --- |
6 | 6 |
|
7 | 7 | # New Pipedrive App |
8 | 8 |
|
9 | | -Run `npx create-pipedrive-app` in the current directory. The CLI will guide the developer through the setup interactively — project name, database, and App Extensions options. |
| 9 | +Collect the developer's choices, then scaffold the project non-interactively. |
10 | 10 |
|
11 | | -Run it now: |
| 11 | +## Step 1: Collect inputs |
| 12 | + |
| 13 | +Ask each question separately and wait for the answer before asking the next. |
| 14 | + |
| 15 | +**Project name** |
| 16 | +Ask: "What should the project be named? (This will also be the output directory name, e.g. `my-pipedrive-app`)" |
| 17 | + |
| 18 | +**Database** |
| 19 | +Ask: "Which database will the app use?" — offer three options: `postgres`, `mysql`, `sqlite`. |
| 20 | + |
| 21 | +**App Extensions** |
| 22 | +Ask: "Should the app include App Extensions (iframe UI panels/modals)? If yes, which types — `custom-panel`, `custom-modal`, or both?" |
| 23 | + |
| 24 | +## Step 2: Run the CLI |
| 25 | + |
| 26 | +Assemble the `--app-extensions` value: |
| 27 | +- No extensions → `none` |
| 28 | +- Custom panel only → `custom-panel` |
| 29 | +- Custom modal only → `custom-modal` |
| 30 | +- Both → `custom-panel,custom-modal` |
| 31 | + |
| 32 | +Run: |
12 | 33 |
|
13 | 34 | ```bash |
14 | | -npx create-pipedrive-app |
| 35 | +npx create-pipedrive-app \ |
| 36 | + --project-name <name> \ |
| 37 | + --database <postgres|mysql|sqlite> \ |
| 38 | + --app-extensions <none|custom-panel|custom-modal|custom-panel,custom-modal> |
15 | 39 | ``` |
| 40 | + |
| 41 | +## Step 3: Report |
| 42 | + |
| 43 | +After the CLI exits successfully, tell the developer what was created and what to do next (refer to the "Next steps" output printed by the CLI). |
0 commit comments