{
"name": "astro",
"description": "CLI provided by Astro to develop, build, and preview your project from a terminal window",
"subcommands": [
{
"name": "add",
"description": "Add an integration",
"options": [
{
"names": [
"--yes"
],
"description": "Accept all prompts"
}
],
"args": [
{
"name": "integration"
}
]
},
{
"name": "build",
"description": "Build your project and write it to disk",
"options": [
{
"names": [
"--drafts"
],
"description": "Include Markdown draft pages in the build"
}
]
},
{
"name": "check",
"description": "Check your project for errors",
"options": [
{
"names": [
"--watch"
],
"description": "Watch Astro files for changes and re-run checks"
}
]
},
{
"name": "dev",
"description": "Starts the development server",
"options": [
{
"names": [
"--port"
],
"description": "Specify a port to listen on",
"takes_arg": true,
"arg": {
"name": "port"
}
},
{
"names": [
"--host"
],
"description": "Listen on all addresses, including LAN and public addresses",
"takes_arg": true,
"arg": {
"name": "custom address"
}
},
{
"names": [
"--open"
],
"description": "Automatically open the app in the browser on server start"
}
]
},
{
"name": "docs",
"description": "Open documentation in your web browser"
},
{
"name": "preview",
"description": "Preview your build locally",
"options": [
{
"names": [
"--open"
],
"description": "Automatically open the app in the browser on server start"
}
]
},
{
"name": "sync",
"description": "Generate content collection types"
},
{
"name": "telemetry",
"description": "Configure telemetry settings",
"subcommands": [
{
"name": "enable",
"description": "Enable anonymous data collection"
},
{
"name": "disable",
"description": "Disable anonymous data collection"
},
{
"name": "reset",
"description": "Reset anonymous data collection settings"
}
]
}
],
"options": [
{
"names": [
"--config"
],
"description": "Specify your config file",
"takes_arg": true,
"arg": {
"name": "path",
"template": "filepaths"
}
},
{
"names": [
"--root"
],
"description": "Specify your project root folder",
"takes_arg": true,
"arg": {
"name": "path",
"template": "folders"
}
},
{
"names": [
"--site"
],
"description": "Specify your project site",
"takes_arg": true,
"arg": {
"name": "url"
}
},
{
"names": [
"--base"
],
"description": "Specify your project base",
"takes_arg": true,
"arg": {
"name": "pathname",
"template": "folders"
}
},
{
"names": [
"--verbose"
],
"description": "Enable verbose logging"
},
{
"names": [
"--silent"
],
"description": "Disable all logging"
},
{
"names": [
"--version"
],
"description": "Show the version number and exit"
},
{
"names": [
"--help"
],
"description": "Show help for astro"
}
]
}