fix: clarify Vike CLI usage (fix #2057)

vikejs · Jan 10, 2025 · 609dc8a · 609dc8a
1 parent 92b93a7
commit 609dc8a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/pages/cli/+Page.mdx b/docs/pages/cli/+Page.mdx
@@ -3,8 +3,8 @@ import { Link } from '@brillout/docpress'
 Usage:
 - `$ vike dev` Start development server.
 - `$ vike build` Build for production.
-- `$ vike preview` Start preview server using production build.
-- `$ vike prerender` <Link href="/pre-rendering">Pre-render</Link> pages.
+- `$ vike preview` Start preview server using production build (only works for <Link href="/glossary#ssg">SSG apps</Link>).
+- `$ vike prerender` <Link href="/pre-rendering">Pre-render</Link> pages (only needed when <Link href="/prerender#disableautorun">`partial.disableAutoRun`</Link> is `true`).
 - `$ vike -v` Print Vike's installed version.
 
 Vike's CLI doesn't have any options, instead:

diff --git a/vike/node/cli/parseCli.ts b/vike/node/cli/parseCli.ts
@@ -6,8 +6,8 @@ import { projectInfo, includes } from './utils.js'
 const commands = [
   { name: 'dev', desc: 'Start development server' },
   { name: 'build', desc: 'Build for production' },
-  { name: 'preview', desc: 'Start preview server using production build' },
-  { name: 'prerender', desc: 'Pre-render pages' }
+  { name: 'preview', desc: 'Start preview server using production build (only works for SSG apps)' },
+  { name: 'prerender', desc: 'Pre-render pages (only needed when partial.disableAutoRun is true)' }
 ] as const
 
 function parseCli() {