help() — astro Function Reference

Architecture documentation for the help() function in help.ts from the astro codebase.

Function typescript CoreAstro CoreMiddleware

Entity Profile

CoreAstro→ CoreMiddleware→ help() — astro Function Reference

Dependency Diagram

graph TD
  b0fa6c4c_eb2f_3a6f_43c5_15fe93adb8ba["help()"]
  08a2b84e_aa58_3283_f02a_1b94642044f8["help.ts"]
  b0fa6c4c_eb2f_3a6f_43c5_15fe93adb8ba -->|defined in| 08a2b84e_aa58_3283_f02a_1b94642044f8
  style b0fa6c4c_eb2f_3a6f_43c5_15fe93adb8ba fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/upgrade/src/actions/help.ts lines 3–15

export function help() {
	printHelp({
		commandName: '@astrojs/upgrade',
		usage: '[version] [...flags]',
		headline: 'Upgrade Astro dependencies.',
		tables: {
			Flags: [
				['--help (-h)', 'See all available flags.'],
				['--dry-run', 'Walk through steps without executing.'],
			],
		},
	});
}