# 安装

<div id="install"></div>

只需三个命令，即可从空文件夹创建并运行一个已配置好路由、网络、主题和代码生成的 Flutter 应用。

<div class="ny-doc-strip">
<span class="ny-doc-strip-label">开始之前</span>
<span class="ny-doc-strip-item">已安装 Flutter SDK</span>
<span class="ny-doc-strip-dot"></span>
<span class="ny-doc-strip-item">Dart 3</span>
<span class="ny-doc-strip-dot"></span>
<a href="/zh/docs/7.x/requirements">完整要求 →</a>
</div>

## 安装

请按顺序运行这些命令。每个命令都可以安全地重复运行。

<div class="ny-doc-steps">
<div class="ny-doc-step">
<span class="ny-doc-step-num">1</span>
<h3 class="ny-doc-step-title">全局安装 Nylo CLI</h3>

这将在您的系统上全局安装 Nylo CLI 工具。

``` bash
dart pub global activate nylo_installer
```

</div>

<div class="ny-doc-step">
<span class="ny-doc-step-num">2</span>
<h3 class="ny-doc-step-title">创建新项目</h3>

此命令会克隆 Nylo 模板，使用您的应用名称配置项目，并自动安装所有依赖。

``` bash
nylo new my_app
```

</div>

<div class="ny-doc-step">
<span class="ny-doc-step-num">3</span>
<h3 class="ny-doc-step-title">设置 Metro 别名</h3>

这将为您的项目配置 `metro` 命令，让您无需完整的 `dart run` 语法即可使用 Metro CLI 命令。

``` bash
cd my_app
nylo init
```

</div>
</div>

<div class="ny-doc-panel">
<div class="ny-doc-panel-head">
<img src="https://nylo.dev/images/nylo_logo.png" alt="" class="ny-mark h-[16px]">
<span>您将获得</span>
</div>
<div class="ny-doc-panel-body">
<div class="ny-doc-panel-grid">
<div class="ny-doc-panel-item">预配置的路由和导航</div>
<div class="ny-doc-panel-item">API 服务模板</div>
<div class="ny-doc-panel-item">主题和本地化设置</div>
<div class="ny-doc-panel-item">用于代码生成的 Metro CLI</div>
</div>
</div>
</div>


<div id="running-the-project"></div>

## 运行项目

Nylo 项目像任何标准 Flutter 应用一样运行。

<div class="ny-doc-tabs" x-data="{ tab: '\u7ec8\u7aef' }">
<div class="ny-doc-tabbar" role="tablist">
<button type="button" role="tab" class="ny-doc-tab" @click="tab = '\u7ec8\u7aef'" :class="tab === '\u7ec8\u7aef' ? 'is-active' : ''" :aria-selected="tab === '\u7ec8\u7aef'">终端</button>
<button type="button" role="tab" class="ny-doc-tab" @click="tab = 'Android Studio'" :class="tab === 'Android Studio' ? 'is-active' : ''" :aria-selected="tab === 'Android Studio'">Android Studio</button>
<button type="button" role="tab" class="ny-doc-tab" @click="tab = 'VS Code'" :class="tab === 'VS Code' ? 'is-active' : ''" :aria-selected="tab === 'VS Code'">VS Code</button>
</div>

<div class="ny-doc-tabpanel" role="tabpanel" x-show="tab === '\u7ec8\u7aef'" x-cloak>

``` bash
flutter run
```

如果构建成功，应用将显示 Nylo 的默认着陆页。

</div>

<div class="ny-doc-tabpanel" role="tabpanel" x-show="tab === 'Android Studio'" x-cloak>

打开项目文件夹，在目标选择器中选择设备，然后按 **Run**。

<a href="https://docs.flutter.dev/tools/android-studio#running-and-debugging" target="_BLANK">Flutter 文档：运行和调试 ↗</a>

</div>

<div class="ny-doc-tabpanel" role="tabpanel" x-show="tab === 'VS Code'" x-cloak>

打开项目文件夹，然后从命令面板运行 **Debug: Start Without Debugging**。

<a href="https://docs.flutter.dev/tools/vs-code#run-app-without-breakpoints" target="_BLANK">Flutter 文档：无断点运行 ↗</a>

</div>

</div>


<div id="metro-cli"></div>

## Metro CLI

Metro 会为您生成项目文件。不带参数运行可查看菜单，也可以直接调用命令。

``` plaintext
$ metro

Metro - Nylo's Companion to Build Flutter apps by Anthony Gordon

Usage:
    command [options] [arguments]

Options
    -h

All commands:

[Widget Commands]
  make:page
  make:stateful_widget
  make:stateless_widget
  make:state_managed_widget
  make:navigation_hub
  make:journey_widget
  make:bottom_sheet_modal
  make:button
  make:form

[Helper Commands]
  make:model
  make:provider
  make:api_service
  make:controller
  make:event
  make:route_guard
  make:config
  make:interceptor
  make:command
  make:env
```

### 命令参考

每个命令都接收一个名称，例如 `metro make:page settings_page`

<div class="ny-doc-commands">
<div class="ny-doc-commands-head">Widget 命令</div>
<div class="ny-doc-command">
<code>metro make:page</code>
<span>创建新页面</span>
</div>
<div class="ny-doc-command">
<code>metro make:stateful_widget</code>
<span>创建有状态组件</span>
</div>
<div class="ny-doc-command">
<code>metro make:stateless_widget</code>
<span>创建无状态组件</span>
</div>
<div class="ny-doc-command">
<code>metro make:state_managed_widget</code>
<span>创建状态管理组件</span>
</div>
<div class="ny-doc-command">
<code>metro make:navigation_hub</code>
<span>创建导航中心（底部导航）</span>
</div>
<div class="ny-doc-command">
<code>metro make:journey_widget</code>
<span>创建导航中心的旅程组件</span>
</div>
<div class="ny-doc-command">
<code>metro make:bottom_sheet_modal</code>
<span>创建底部弹窗</span>
</div>
<div class="ny-doc-command">
<code>metro make:button</code>
<span>创建自定义按钮组件</span>
</div>
<div class="ny-doc-command">
<code>metro make:form</code>
<span>创建带验证的表单</span>
</div>
</div>

<div class="ny-doc-commands">
<div class="ny-doc-commands-head">辅助命令</div>
<div class="ny-doc-command">
<code>metro make:model</code>
<span>创建模型类</span>
</div>
<div class="ny-doc-command">
<code>metro make:provider</code>
<span>创建 provider</span>
</div>
<div class="ny-doc-command">
<code>metro make:api_service</code>
<span>创建 API 服务</span>
</div>
<div class="ny-doc-command">
<code>metro make:controller</code>
<span>创建控制器</span>
</div>
<div class="ny-doc-command">
<code>metro make:event</code>
<span>创建事件</span>
</div>
<div class="ny-doc-command">
<code>metro make:route_guard</code>
<span>创建路由守卫</span>
</div>
<div class="ny-doc-command">
<code>metro make:config</code>
<span>创建配置文件</span>
</div>
<div class="ny-doc-command">
<code>metro make:interceptor</code>
<span>创建网络拦截器</span>
</div>
<div class="ny-doc-command">
<code>metro make:command</code>
<span>创建自定义 Metro 命令</span>
</div>
<div class="ny-doc-command">
<code>metro make:env</code>
<span>从 .env 生成环境配置</span>
</div>
</div>

### 使用示例

``` bash
# Create a new page
metro make:page settings_page

# Create a model
metro make:model User

# Create an API service
metro make:api_service user_api_service
```