@feltdb/core 0.4.6 → 0.4.8

package/dist/create/cli.js

@@ -125,7 +125,51 @@ async function promptForOptions(defaults) {
 async function main() {
     const args = process.argv.slice(2);
     if (args.includes('--help') || args.includes('-h')) {
-        console.log(`create-feltdb ${FELTDB_PACKAGE_VERSION}\n\nUsage: create-feltdb [project-name] [options]\n\nOptions:\n  --runtime <browser|node|self-hosted>\n  --framework <react|vanilla>\n  --no-distributed\n  --no-agents\n  --capabilities <list>\n  --no-install\n  --no-start\n  -y, --yes\n  -h, --help\n  --version`);
+        console.log(`create-feltdb ${FELTDB_PACKAGE_VERSION}
+
+Create a new FeltDB application with one command.
+
+Usage:
+  create-feltdb [project-name] [options]
+
+Examples:
+  create-feltdb my-app
+  create-feltdb my-app --runtime browser --framework react
+  create-feltdb my-app --yes --no-start
+
+Runtime Options:
+  --runtime browser       Local-first with durable browser storage (OPFS)
+                          Best for: Client-side apps, offline-first experiences
+
+  --runtime node          Node.js application server or worker
+                          Best for: Server-side applications, API servers
+
+  --runtime self-hosted   Dedicated FeltDB server instance
+                          Best for: Production deployments, multi-user systems
+                          Note: Requires Docker (image: ghcr.io/rkendel1/feltdb)
+
+Options:
+  --runtime <runtime>      Set application runtime (default: browser)
+  --framework <framework>  Choose framework: react or vanilla (default: react)
+  --no-distributed         Disable distributed operation
+  --no-agents              Exclude agent examples
+  --capabilities <list>    Choose capabilities: search, vector, or search,vector
+  --no-install             Skip npm install
+  --no-start               Skip npm run dev
+  -y, --yes                Use all defaults (non-interactive mode)
+  -h, --help               Show this help message
+  --version                Show version number
+
+Vector Search:
+  Vector search requires additional dependencies and setup. If you choose
+  "Search + vector search" during setup, make sure to review the documentation
+  for configuring your vector database connection.
+
+Environment Variables:
+  FELTDB_IMAGE             Override the default self-hosted container image
+  NODE_ENV                 Set to 'development' or 'production'
+
+Learn more: https://github.com/rkendel1/feltdb`);
         return;
     }
     if (args.includes('--version')) {
@@ -152,8 +196,13 @@ async function main() {
     console.log('\n✨ Creating FeltDB Application\n');
     if (!shouldAutoYes) {
         options = await promptForOptions(options);
+        const runtimeDescriptions = {
+            'browser': 'Local-first with browser storage',
+            'node': 'Node.js server runtime',
+            'self-hosted': 'Dedicated FeltDB server',
+        };
         console.log('\nConfiguration:');
-        console.log(`  Runtime:       ${options.runtime}`);
+        console.log(`  Runtime:       ${options.runtime} (${runtimeDescriptions[options.runtime]})`);
         console.log(`  Framework:     ${options.framework}`);
         console.log(`  Distributed:   ${options.distributed ? 'yes' : 'no'}`);
         console.log(`  Agents:        ${options.agents ? 'yes' : 'no'}`);