Команды CLI
Вы можете использовать интерфейс командной строки (CLI), предоставляемый Astro, для разработки, сборки и предварительного просмотра вашего проекта из окна терминала.
Команды astro
Заголовок раздела Команды astroИспользуйте CLI, выполнив одну из команд, задокументированных на этой странице, с помощью предпочитаемого пакетного менеджера, а затем добавьте любые флаги. Флаги определяют поведение команды.
Одна из команд, которую вы будете использовать чаще всего, — astro dev
. Эта команда запускает сервер разработки и предоставляет вам живой, обновляемый предварительный просмотр вашего сайта в браузере во время работы:
Вы можете набрать в терминале astro --help
, чтобы вывести список всех доступных команд:
На экране вашего терминала появится следующее сообщение:
Дополнительный --
перед любым флагом необходим для того, чтобы npm
передал ваши флаги команде astro
.
Скрипты package.json
Заголовок раздела Скрипты package.jsonВы также можете использовать скрипты в package.json
для более коротких версий этих команд. Использование скриптов позволяет вам использовать те же команды, с которыми вы можете быть знакомы по другим проектам, например npm run build
.
Следующие скрипты для наиболее распространённых команд astro
(astro dev
, astro build
и astro preview
) добавляются автоматически при создании проекта с помощью инструмента create astro
.
Когда вы следуете инструкциям по установке Astro вручную, вам предлагается самостоятельно добавить эти скрипты. Вы также можете добавить в этот список дополнительные скрипты вручную для часто используемых команд.
Часто вы будете использовать эти команды astro
или скрипты, которые их запускают, без каких-либо флагов. Добавляйте флаги к команде, когда хотите настроить её поведение. Например, вы можете запустить сервер разработки на другом порту или создать сайт с подробными логами для отладки.
astro dev
Заголовок раздела astro devЗапускает сервер разработки Astro. Это локальный HTTP-сервер, который не объединяет ресурсы. Он использует горячую замену модулей (HMR) для обновления браузера при сохранении изменений в редакторе.
astro build
Заголовок раздела astro buildСоздает ваш сайт для развёртывания. По умолчанию генерируются статические файлы и помещаются в каталог dist/
. Если SSR включен, будут сгенерированы необходимые серверные файлы для обслуживания вашего сайта.
Может сочетаться с общими флагами, описанными ниже.
astro preview
Заголовок раздела astro previewЗапускает локальный сервер для обслуживания содержимого вашего статического каталога (по умолчанию dist/
), созданного при запуске astro build
.
Эта команда позволяет локально просмотреть сайт после сборки, чтобы выявить любые ошибки в результатах сборки перед её развёртыванием. Она не предназначена для запуска в производстве. Чтобы получить помощь в развёртывании сайта на производстве, ознакомьтесь с нашим руководством Развёртывание сайта Astro.
Начиная с версии Astro 1.5.0, astro preview
также работает для сборок SSR, если вы используете адаптер, который поддерживает эту функцию. В настоящее время только адаптер Node поддерживает astro preview
.
Может сочетаться с общими флагами, описанными ниже.
astro check
Заголовок раздела astro checkВыполняет диагностику (например, проверку типов в файлах .astro
) вашего проекта и сообщает об ошибках в консоль. Если обнаружены ошибки, процесс завершится с кодом 1.
Эта команда предназначена для использования в рабочих процессах CI.
Флаги
Используйте эти флаги, чтобы настроить поведение команды.
--watch
Заголовок раздела --watchКоманда будет следить за изменениями в вашем проекте и сообщать о любых ошибках.
astro sync
Заголовок раздела astro sync
Добавлено в:
astro@2.0.0
Запуск astro dev
, astro build
или astro check
также запустит команду sync
.
Генерирует типы TypeScript для всех модулей Astro. Это настраивает src/env.d.ts
файл для определения типов и определяет модули для функций, которые зависят от сгенерированных типов:
- Модуль
astro:content
для API коллекций контента. - Модуль
astro:db
для Astro DB.
astro add
Заголовок раздела astro addДобавляет интеграцию в вашу конфигурацию. Подробнее в руководстве по интеграциям.
astro docs
Заголовок раздела astro docsЗапускает веб-сайт Astro Docs прямо из терминала.
astro info
Заголовок раздела astro infoСообщает полезную информацию о текущем окружении Astro. Полезно для предоставления информации при открытии проблемы.
Пример вывода:
astro preferences
Заголовок раздела astro preferencesУправляйте предпочтениями пользователей с помощью команды astro preferences
. Пользовательские предпочтения являются специфическими для отдельных пользователей Astro, в отличие от файла astro.config.mjs
, который изменяет поведение всех, кто работает над проектом.
Пользовательские настройки по умолчанию привязаны к текущему проекту и хранятся в локальном файле .astro/settings.json
.
Используя флаг --global
, пользовательские настройки можно также применить ко всем проектам Astro на текущей машине. Глобальные пользовательские настройки хранятся в специфическом для операционной системы месте.
Например, чтобы отключить панель devToolbar в конкретном проекте Astro:
Чтобы отключить панель devToolbar во всех проектах Astro на текущей машине:
Впоследствии панель devToolbar можно включить с помощью:
Команда reset
возвращает предпочтение к значению по умолчанию:
Команда list
выводит текущие настройки всех конфигурируемых пользовательских предпочтений. Она также поддерживает машиночитаемый вывод --json
.
astro telemetry
Заголовок раздела astro telemetryУстанавливает конфигурацию телеметрии для текущего пользователя CLI. Телеметрия — это анонимные данные, которые дают команде Astro представление о том, какие функции Astro используются чаще всего. Дополнительные сведения см. на странице Телеметрия Astro.
Телеметрию можно отключить с помощью этой команды CLI:
Впоследствии телеметрию можно снова включить с помощью:
Команда reset
сбрасывает данные телеметрии:
Добавьте команду astro telemetry disable
в ваши CI-скрипты или установите переменную окружения ASTRO_TELEMETRY_DISABLED
.
Общие флаги
Заголовок раздела Общие флаги--root <path>
Заголовок раздела --root <path>Указывает путь к корню проекта. Если путь не указан, корнем считается текущий рабочий каталог.
Корень используется для поиска файла конфигурации Astro.
--config <path>
Заголовок раздела --config <path>Указывает путь к файлу конфигурации относительно корня проекта. По умолчанию astro.config.mjs
. Используйте это значение, если вы используете другое имя для файла конфигурации или файл конфигурации находится в другой папке.
--outDir <path>
Заголовок раздела --outDir <path>
Добавлено в:
astro@3.3.0
Настраивает outDir
для вашего проекта. Передача этого флага отменяет значение outDir
в вашем файле astro.config.mjs
, если оно существует.
--site <url>
Заголовок раздела --site <url>Настраивает site
для вашего проекта. Передача этого флага отменяет значение site
в вашем файле astro.config.mjs
, если оно существует.
--base <pathname>
Заголовок раздела --base <pathname>
Добавлено в:
astro@1.4.1
Настраивает base
для вашего проекта. Передача этого флага отменяет значение base
в вашем файле astro.config.mjs
, если оно существует.
--port <number>
Заголовок раздела --port <number>Указывает, на каком порту запускать dev-сервер и сервер предварительного просмотра. По умолчанию 4321
.
--host [optional host address]
Заголовок раздела --host [optional host address]Устанавливает, какие сетевые IP-адреса должны прослушивать сервер разработки и сервер предпросмотра (т. е. IP-адреса, не относящиеся к localhost). Это может быть полезно для тестирования проекта на локальных устройствах, таких как мобильный телефон, во время разработки.
--host
— прослушивать все адреса, включая адреса локальной сети и публичные адреса--host <custom-address>
— выставлять IP-адрес сети по адресу<custom-address>
Не используйте флаг --host
для открытия сервера разработки и сервера предварительного просмотра в производственной среде. Эти серверы предназначены только для локального использования при разработке вашего сайта.
--verbose
Заголовок раздела --verboseВключает ведение подробного журнала, что полезно при отладке проблемы.
--silent
Заголовок раздела --silentВключает бесшумное протоколирование, при котором сервер будет работать без вывода данных на консоль.
Глобальные флаги
Заголовок раздела Глобальные флагиИспользуйте эти флаги, чтобы получить информацию о CLI astro
.
--version
Заголовок раздела --versionВыводит номер версии Astro и выходит из программы.
--open
Заголовок раздела --openАвтоматически открывает приложение в браузере при запуске сервера. Можно передать полную строку URL (например, --open http://example.com
) или имя пути (например, --open /about
), чтобы указать URL для открытия.
--help
Заголовок раздела --helpВыводит сообщение о помощи и завершает работу.
Расширенные API (экспериментальные)
Заголовок раздела Расширенные API (экспериментальные)Если вам нужно больше контроля при запуске Astro, пакет "astro"
также экспортирует API для программного запуска команд CLI.
Эти API являются экспериментальными, и сигнатура их API может измениться. Любые обновления будут упомянуты в списке изменений Astro, а информация ниже всегда будет отображать текущую, актуальную информацию.
AstroInlineConfig
Заголовок раздела AstroInlineConfigТип AstroInlineConfig
используется всеми командными API, представленными ниже. Он расширяет пользовательский тип конфигурации Astro.:
configFile
Заголовок раздела configFileТип: string | false
По умолчанию: undefined
Пользовательский путь к файлу конфигурации Astro.
Если это значение не определено (по умолчанию) или не установлено, Astro будет искать файл astro.config.(js,mjs,ts)
относительно root
и загружать его, если найдет.
Если задан относительный путь, он будет разрешен на основе текущего рабочего каталога.
Установите значение false
, чтобы отключить загрузку любых файлов конфигурации.
Встроенный конфиг, переданный в этот объект, будет иметь наивысший приоритет при объединении с загруженным пользовательским конфигом.
Тип: "development" | "production"
По умолчанию: "development"
при запуске astro dev
, "production"
при запуске astro build
Режим, используемый при сборке вашего сайта для генерации кода либо “development” (разработка), либо “production” (производство).
logLevel
Заголовок раздела logLevelТип: "debug" | "info" | "warn" | "error" | "silent"
По умолчанию: "info"
Уровень регистрации для фильтрации сообщений, регистрируемых Astro.
"debug"
: Записывайте в журнал все, включая шумную отладочную диагностику."info"
: Записывать в журнал информационные сообщения, предупреждения и ошибки."warn"
: Заносить в журнал предупреждения и ошибки."error"
: Заносить в журнал только ошибки."silent"
: Не вести журнал.
Тип: (inlineConfig: AstroInlineConfig) => AstroDevServer
.
Подобно astro dev
, он запускает сервер разработки Astro.
build()
Заголовок раздела build()Тип: (inlineConfig: AstroInlineConfig) => void
.
Подобно astro build
, он создает ваш сайт для развертывания.
preview()
Заголовок раздела preview()Тип: (inlineConfig: AstroInlineConfig) => AstroPreviewServer
.
Аналогично astro preview
, запускает локальный сервер для обслуживания вашего статического каталога dist/
.
sync()
Заголовок раздела sync()Тип: (inlineConfig: AstroInlineConfig) => number
Подобно astro sync
, он генерирует типы TypeScript для всех модулей Astro
Astro Studio CLI
Заголовок раздела Astro Studio CLIastro login
Заголовок раздела astro loginАутентификация с помощью Astro Studio. Это необходимо для выполнения всех команд управления базой данных, включая astro link.
astro link
Заголовок раздела astro linkСсылка на вашу базу данных, размещённую в Studio. Это необходимо для выполнения команд Astro DB для управления базой данных. Для привязки базы данных вам будет предложено выбрать существующую базу данных или создать новую.
astro logout
Заголовок раздела astro logoutВыход из Astro Studio и удаление всех локально сохранённых ключей аутентификации.
Reference