summaryrefslogtreecommitdiff
path: root/packages/create-astro/src/actions/help.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/create-astro/src/actions/help.ts')
-rw-r--r--packages/create-astro/src/actions/help.ts24
1 files changed, 24 insertions, 0 deletions
diff --git a/packages/create-astro/src/actions/help.ts b/packages/create-astro/src/actions/help.ts
new file mode 100644
index 000000000..1d5c7f609
--- /dev/null
+++ b/packages/create-astro/src/actions/help.ts
@@ -0,0 +1,24 @@
+import { printHelp } from '../messages.js';
+
+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.'],
+ ],
+ },
+ });
+}