dappbooster 3.1.0 → 3.1.5

package/package.json

@@ -1,7 +1,31 @@
 {
   "name": "dappbooster",
-  "version": "3.1.0",
+  "version": "3.1.5",
+  "description": "Agent-friendly dAppBooster installer that scaffolds Web3 dApps via TUI or non-interactive CLI/CI.",
+  "keywords": [
+    "dappbooster",
+    "dapp",
+    "web3",
+    "blockchain",
+    "ethereum",
+    "evm",
+    "scaffolding",
+    "starter",
+    "template",
+    "cli",
+    "installer",
+    "generator",
+    "tui",
+    "non-interactive",
+    "ci",
+    "agent",
+    "automation"
+  ],
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BootNodeDev/dAppBoosterInstallScript"
+  },
   "bin": "dist/cli.js",
   "type": "module",
   "engines": {

package/readme.md

@@ -1,6 +1,6 @@
 # dAppBooster installer
 
-An easy way to install and customize [dAppBooster](https://dappbooster.dev/)
+Agent-friendly installer for [dAppBooster](https://dappbooster.dev/) that scaffolds Web3 dApps via TUI or non-interactive CLI/CI with JSON output.
 
 ## Requirements
 
@@ -17,6 +17,115 @@ pnpm dlx dappbooster
 
 dAppBooster documentation: https://docs.dappbooster.dev/
 
+## Agent / CI quickstart
+
+Use `--info` to discover features, then run a non-interactive install that returns JSON.
+
+```shell
+pnpm dlx dappbooster --info
+pnpm dlx dappbooster --ni --name my_dapp --mode full
+```
+
+## Agent / non-interactive / CI mode
+
+The installer supports a non-interactive mode for CI pipelines and AI agents. It activates automatically when stdout is not a TTY, or explicitly with the `--ni` flag.
+
+### Discover available features
+
+```shell
+pnpm dlx dappbooster --info
+```
+
+```json
+{
+  "features": {
+    "demo": {
+      "description": "Component demos and example pages",
+      "default": true
+    },
+    "subgraph": {
+      "description": "TheGraph subgraph integration",
+      "default": true,
+      "postInstall": [
+        "Provide your own API key for PUBLIC_SUBGRAPHS_API_KEY in .env.local",
+        "Run pnpm subgraph-codegen from the project folder"
+      ]
+    },
+    "typedoc": {
+      "description": "TypeDoc API documentation generation",
+      "default": true
+    },
+    "vocs": {
+      "description": "Vocs documentation site",
+      "default": true
+    },
+    "husky": {
+      "description": "Git hooks with Husky, lint-staged, and commitlint",
+      "default": true
+    }
+  },
+  "modes": {
+    "full": "Install all features",
+    "custom": "Choose features individually"
+  }
+}
+```
+
+### Full install
+
+```shell
+pnpm dlx dappbooster --ni --name my_dapp --mode full
+```
+
+```json
+{
+  "success": true,
+  "projectName": "my_dapp",
+  "mode": "full",
+  "features": ["demo", "subgraph", "typedoc", "vocs", "husky"],
+  "path": "/absolute/path/to/my_dapp",
+  "postInstall": [
+    "Provide your own API key for PUBLIC_SUBGRAPHS_API_KEY in .env.local",
+    "Run pnpm subgraph-codegen from the project folder"
+  ]
+}
+```
+
+### Custom install with selected features
+
+```shell
+pnpm dlx dappbooster --ni --name my_dapp --mode custom --features demo,subgraph
+```
+
+```json
+{
+  "success": true,
+  "projectName": "my_dapp",
+  "mode": "custom",
+  "features": ["demo", "subgraph"],
+  "path": "/absolute/path/to/my_dapp",
+  "postInstall": [
+    "Provide your own API key for PUBLIC_SUBGRAPHS_API_KEY in .env.local",
+    "Run pnpm subgraph-codegen from the project folder"
+  ]
+}
+```
+
+### Error handling
+
+Errors return structured JSON with a non-zero exit code:
+
+```shell
+pnpm dlx dappbooster --ni --mode full
+```
+
+```json
+{
+  "success": false,
+  "error": "Missing required flag: --name"
+}
+```
+
 ## Development
 
 Clone the repo
@@ -41,4 +150,4 @@ node cli.js
 
 ## Releasing new versions to NPM
 
-New releases are automatically uploaded to NPM using GitHub actions.
+New releases are automatically uploaded to NPM using GitHub actions.

package/dist/components/steps/CloneRepo/Commands.d.ts

@@ -1,12 +0,0 @@
-import type { FC } from 'react';
-interface Props {
-    projectName: string;
-    onCompletion: () => void;
-}
-/**
- * Executes all the commands to clone the dAppBooster repository.
- * @param projectName
- * @param onCompletion
- */
-declare const Commands: FC<Props>;
-export default Commands;

package/dist/components/steps/CloneRepo/Commands.js

@@ -1,16 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { join } from 'node:path';
-import * as process from 'node:process';
-import { Box, Text } from 'ink';
-import { Script, Spawn } from 'ink-spawn';
-import { repoUrl } from '../../../constants/config.js';
-/**
- * Executes all the commands to clone the dAppBooster repository.
- * @param projectName
- * @param onCompletion
- */
-const Commands = ({ projectName, onCompletion }) => {
-    const projectFolder = join(process.cwd(), projectName);
-    return (_jsx(Box, { flexDirection: 'column', gap: 0, children: _jsxs(Script, { children: [_jsxs(Box, { columnGap: 1, children: [_jsx(Text, { color: 'whiteBright', children: "Cloning dAppBooster in" }), _jsx(Text, { italic: true, children: projectName })] }), _jsx(Spawn, { shell: true, silent: true, successText: 'Done!', failureText: `Failed to clone the project, check if a folder called "${projectName}" already exists and your read/write permissions...`, runningText: 'Working...', command: "git", args: ['clone', '--depth', '1', '--no-checkout', repoUrl, projectName] }), _jsx(Text, { color: 'whiteBright', children: "Fetching tags" }), _jsx(Spawn, { shell: true, cwd: projectFolder, silent: true, command: 'git', args: ['fetch', '--tags'], runningText: 'Working...', successText: 'Done!', failureText: 'Error...' }), _jsx(Text, { color: 'whiteBright', children: "Checking out latest tag" }), _jsx(Spawn, { shell: true, cwd: projectFolder, command: "git", args: ['checkout $(git describe --tags `git rev-list --tags --max-count=1`)'], successText: "Done!", failureText: 'Error...' }), _jsx(Text, { color: 'whiteBright', children: "Removing .git folder" }), _jsx(Spawn, { shell: true, cwd: projectFolder, command: "rm", args: ['-rf', '.git'], successText: "Done!", failureText: 'Error...' }), _jsx(Text, { color: 'whiteBright', children: "Initializing Git repository" }), _jsx(Spawn, { shell: true, cwd: projectFolder, command: "git", args: ['init'], successText: "Done!", failureText: 'Error...', onCompletion: onCompletion })] }) }));
-};
-export default Commands;

package/dist/components/steps/Install/CustomInstallation.d.ts

@@ -1,16 +0,0 @@
-import type { FC } from 'react';
-import type { MultiSelectItem } from '../../../types/types.js';
-interface Props {
-    onCompletion: () => void;
-    projectFolder: string;
-    selectedFeatures?: Array<MultiSelectItem>;
-}
-/**
- * Performs a custom installation based on the selected features: basically we tell `pnpm` what
- * features to remove (everything's included in package.json by default to simplify things)
- * @param onCompletion
- * @param selectedFeatures
- * @param projectFolder
- */
-declare const CustomInstallation: FC<Props>;
-export default CustomInstallation;

package/dist/components/steps/Install/CustomInstallation.js

@@ -1,26 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { Box, Text } from 'ink';
-import { Script, Spawn } from 'ink-spawn';
-import { getPackages } from '../../../utils/utils.js';
-import InstallAllPackages from './InstallAllPackages.js';
-/**
- * Performs a custom installation based on the selected features: basically we tell `pnpm` what
- * features to remove (everything's included in package.json by default to simplify things)
- * @param onCompletion
- * @param selectedFeatures
- * @param projectFolder
- */
-const CustomInstallation = ({ onCompletion, selectedFeatures, projectFolder }) => {
-    // Collects the packages to remove based on the selected features and makes
-    // a string out of them so that we can pass it to `pnpm remove` command.
-    const packagesToRemove = [
-        ...getPackages('subgraph', selectedFeatures),
-        ...getPackages('typedoc', selectedFeatures),
-        ...getPackages('vocs', selectedFeatures),
-        ...getPackages('husky', selectedFeatures),
-    ]
-        .join(' ')
-        .trim();
-    return (_jsx(Box, { flexDirection: 'column', gap: 0, children: !packagesToRemove ? (_jsx(Script, { children: _jsx(InstallAllPackages, { projectFolder: projectFolder, onCompletion: onCompletion }) })) : (_jsxs(Script, { children: [_jsx(Text, { color: 'whiteBright', children: "Installing packages" }), _jsx(Spawn, { shell: true, cwd: projectFolder, silent: true, command: 'pnpm', args: ['remove', packagesToRemove], runningText: 'Working...', successText: 'Done!', failureText: 'Error...' }), _jsx(Text, { color: 'whiteBright', children: "Executing post-install scripts" }), _jsx(Spawn, { shell: true, cwd: projectFolder, silent: true, command: 'pnpm', args: ['run', 'postinstall'], runningText: 'Working...', successText: 'Done!', failureText: 'Error...', onCompletion: onCompletion })] })) }));
-};
-export default CustomInstallation;

package/dist/components/steps/Install/FullInstallation.d.ts

@@ -1,7 +0,0 @@
-import type { FC } from 'react';
-interface Props {
-    projectFolder: string;
-    onCompletion?: () => void;
-}
-declare const FullInstallation: FC<Props>;
-export default FullInstallation;

package/dist/components/steps/Install/FullInstallation.js

@@ -1,8 +0,0 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import { Box } from 'ink';
-import { Script } from 'ink-spawn';
-import InstallAllPackages from './InstallAllPackages.js';
-const FullInstallation = ({ onCompletion, projectFolder }) => {
-    return (_jsx(Box, { flexDirection: 'column', gap: 0, children: _jsx(Script, { children: _jsx(InstallAllPackages, { projectFolder: projectFolder, onCompletion: onCompletion }) }) }));
-};
-export default FullInstallation;

package/dist/components/steps/Install/InstallAllPackages.d.ts

@@ -1,7 +0,0 @@
-import type { FC } from 'react';
-interface Props {
-    onCompletion?: () => void;
-    projectFolder: string;
-}
-declare const InstallAllPackages: FC<Props>;
-export default InstallAllPackages;

package/dist/components/steps/Install/InstallAllPackages.js

@@ -1,7 +0,0 @@
-import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
-import { Text } from 'ink';
-import { Spawn } from 'ink-spawn';
-const InstallAllPackages = ({ projectFolder, onCompletion }) => {
-    return (_jsxs(_Fragment, { children: [_jsx(Text, { color: 'whiteBright', children: "Installing packages" }), _jsx(Spawn, { shell: true, cwd: projectFolder, silent: true, command: 'pnpm', args: ['i'], runningText: 'Working...', successText: 'Done!', failureText: 'Error...', onCompletion: onCompletion })] }));
-};
-export default InstallAllPackages;