Merge pull request #18 from get-convex/magicseth/check-gh-issues

Clarify --component flag refers to module name

Author: sethconvex

INTEGRATION.md

@@ -295,11 +295,12 @@ npm install @convex-dev/static-hosting
 - You must create `convex/http.ts` and register routes
 - Run `npx convex dev` to regenerate types after adding http.ts
 
-### Component name mismatch
-Default component name is `staticHosting`. If you named your file differently or used a different component name in config, specify it:
+### `--component` is the module name, not the component name
+Despite its name, `--component <name>` refers to the **Convex module** where you exposed the upload API (i.e. `convex/<name>.ts`), not the component name registered in `convex.config.ts`. If you put the `exposeUploadApi(...)` re-exports in `convex/myCustomName.ts`, pass:
 ```bash
 npx @convex-dev/static-hosting upload --component myCustomName
 ```
+Default is `staticHosting` (i.e. `convex/staticHosting.ts`).
 
 ## API Reference
 

README.md

@@ -127,7 +127,8 @@ npx @convex-dev/static-hosting upload [options]
 
 Options:
   -d, --dist <path>           Path to dist directory (default: ./dist)
-  -c, --component <name>      Convex component name (default: staticHosting)
+  -c, --component <module>    Module name where upload API is exposed — i.e.
+                              convex/<module>.ts (default: staticHosting)
       --prod                  Deploy to production Convex deployment
       --dev                   Deploy to dev deployment (default)
   -b, --build                 Run 'npm run build' with correct VITE_CONVEX_URL
@@ -203,7 +204,8 @@ npx @convex-dev/static-hosting deploy [options]
 
 Options:
   -d, --dist <path>           Path to dist directory (default: ./dist)
-  -c, --component <name>      Convex component name (default: staticHosting)
+  -c, --component <module>    Module name where upload API is exposed — i.e.
+                              convex/<module>.ts (default: staticHosting)
       --skip-build            Skip the build step (use existing dist)
       --skip-convex           Skip Convex backend deployment
   -h, --help                  Show help

src/cli/deploy.ts

@@ -65,7 +65,9 @@ Minimizes the inconsistency window between backend and frontend updates.
 
 Options:
   -d, --dist <path>           Path to dist directory (default: ./dist)
-  -c, --component <name>      Convex component name (default: staticHosting)
+  -c, --component <module>    Module name where upload API is exposed — i.e.
+                              convex/<module>.ts (default: staticHosting). Not
+                              the registered component name from convex.config.ts.
       --skip-build            Skip the build step (use existing dist)
       --skip-convex           Skip Convex backend deployment
       --cdn                   Upload non-HTML assets to convex-fs CDN

src/cli/init.ts

@@ -161,7 +161,7 @@ npx @convex-dev/static-hosting upload [options]
 
 Options:
   -d, --dist <path>        Path to dist directory (default: ./dist)
-  -c, --component <name>   Convex component name (default: staticHosting)
+  -c, --component <module> Module name where upload API is exposed — i.e. convex/<module>.ts (default: staticHosting)
       --prod               Deploy to production Convex deployment
       --dev                Deploy to dev deployment (default)
   -b, --build              Run 'npm run build' with correct VITE_CONVEX_URL

src/cli/upload.ts

@@ -7,7 +7,7 @@
  *
  * Options:
  *   --dist <path>            Path to dist directory (default: ./dist)
- *   --component <name>       Convex component with upload functions (default: staticHosting)
+ *   --component <module>     Module name where upload API is exposed — i.e. convex/<module>.ts (default: staticHosting)
  *   --prod                   Deploy to production deployment
  *   --help                   Show help
  */
@@ -102,7 +102,9 @@ Upload static files from a dist directory to Convex storage.
 
 Options:
   -d, --dist <path>           Path to dist directory (default: ./dist)
-  -c, --component <name>      Convex component with upload functions (default: staticHosting)
+  -c, --component <module>    Module name where upload API is exposed — i.e.
+                              convex/<module>.ts (default: staticHosting). Not
+                              the registered component name from convex.config.ts.
       --prod                  Deploy to production deployment
   -b, --build                 Run 'npm run build' with correct VITE_CONVEX_URL before uploading
       --cdn                   Upload non-HTML assets to convex-fs CDN instead of Convex storage