help() — astro Function Reference

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

Function typescript CoreAstro RenderingEngine

Entity Profile

CoreAstro→ RenderingEngine→ help() — astro Function Reference

Dependency Diagram

graph TD
  6fe902ba_e37b_cb48_431d_c3d147b70303["help()"]
  35fd9215_b000_0d0c_0933_5f9d91ad68b9["help.ts"]
  6fe902ba_e37b_cb48_431d_c3d147b70303 -->|defined in| 35fd9215_b000_0d0c_0933_5f9d91ad68b9
  style 6fe902ba_e37b_cb48_431d_c3d147b70303 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/create-astro/src/actions/help.ts lines 3–24

export function help() {
	printHelp({
		commandName: 'create-astro',
		usage: '[dir] [...flags]',
		headline: 'Scaffold Astro projects.',
		tables: {
			Flags: [
				['--help (-h)', 'See all available flags.'],
				['--template <name>', 'Specify your template.'],
				['--install / --no-install', 'Install dependencies (or not).'],
				['--add <integrations>', 'Add integrations.'],
				['--git / --no-git', 'Initialize git repo (or not).'],
				['--yes (-y)', 'Skip all prompts by accepting defaults.'],
				['--no (-n)', 'Skip all prompts by declining defaults.'],
				['--dry-run', 'Walk through steps without executing.'],
				['--skip-houston', 'Skip Houston animation.'],
				['--ref', 'Choose astro branch (default: latest).'],
				['--fancy', 'Enable full Unicode support for Windows.'],
			],
		},
	});
}