# Installation

Three commands take you from an empty folder to a running Flutter app with routing, networking, themes and code generation already wired up.

Before you start Flutter SDK installed Dart 3 Full requirements →

## Install Run these in order. Each one is safe to re-run.

Install the Nylo CLI globally

Puts the `nylo` command on your system. ``` bash dart pub global activate nylo_installer ```

Create a new project

Clones the Nylo template, renames it to your app, and installs dependencies. ``` bash nylo new my_app ```

Set up the Metro alias

Lets you type `metro` instead of the full `dart run` syntax. ``` bash cd my_app nylo init ``` Restart your terminal afterwards, or run the `source` command that `nylo init` prints.

What you get

Pre-configured routing and navigation

API service boilerplate

Theme and localization setup

Metro CLI for code generation

## Running the Project Nylo projects run like any standard Flutter app.

``` bash flutter run ``` On a successful build the app opens on Nylo's default landing screen.

Open the project folder, pick a device from the target selector, then press **Run**. Flutter docs: running and debugging ↗

Open the project folder, then run **Debug: Start Without Debugging** from the command palette. Flutter docs: run app without breakpoints ↗

## Metro CLI Metro generates project files for you. Run it bare to see the menu, or call a command directly. ``` 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 ``` ### Command reference Every command takes a name, e.g. `metro make:page settings_page`

Widget commands

metro make:page Create a new page

metro make:stateful_widget Create a stateful widget

metro make:stateless_widget Create a stateless widget

metro make:state_managed_widget Create a state-managed widget

metro make:navigation_hub Create a navigation hub (bottom nav)

metro make:journey_widget Create a journey widget for a navigation hub

metro make:bottom_sheet_modal Create a bottom sheet modal

metro make:button Create a custom button widget

metro make:form Create a form with validation

Helper commands

metro make:model Create a model class

metro make:provider Create a provider

metro make:api_service Create an API service

metro make:controller Create a controller

metro make:event Create an event

metro make:route_guard Create a route guard

metro make:config Create a config file

metro make:interceptor Create a network interceptor

metro make:command Create a custom Metro command

metro make:env Generate environment config from .env

### Example usage ``` 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 ```

## Nylo CLI

Requires nylo_installer 1.8.0+ Update the CLI →

The `nylo` command from step 1 does more than create projects. Run it from your project directory to clean builds, refresh iOS pods, run tests, and check your translations.

Project commands

nylo new Create a new project

nylo init Set up the metro alias in your shell

nylo clean Run flutter clean and flutter pub get

nylo ios:pod-refresh Reinstall your iOS pods

nylo metro Run a Metro command without the alias

Testing and translations

nylo test Format and run your tests

nylo locale:find-untranslated Find text that isn't wrapped in .tr()

nylo locale:check-missing-keys Find keys missing from your lang files

The CLI itself

nylo self-update Update nylo to the latest version

nylo --version Show the installed version

Commands that take options list them with `-h`, for example `nylo test -h`. Testing is covered in [Running Tests](/docs/7.x/testing#running-tests), and the `locale:` commands in [Auditing Translations](/docs/7.x/localization#auditing-translations).

### Cleaning a project `nylo clean` runs `flutter clean` and then `flutter pub get`. Add a platform flag when a normal clean isn't enough: ``` bash # flutter clean, then flutter pub get nylo clean # Also remove ios/Pods, ios/.symlinks and ios/Podfile.lock, then run pod install --repo-update nylo clean --ios # Also run gradlew clean in android/ nylo clean --android # Both of the above nylo clean --all ``` If a project has no `ios/` or `android/` folder, that platform is skipped with a warning. `pod install` only runs on macOS.

### Refreshing iOS pods When CocoaPods gets out of sync, `nylo ios:pod-refresh` deletes `ios/Pods`, `ios/.symlinks` and `ios/Podfile.lock`, then runs `pod install --repo-update` in the `ios/` folder: ``` bash nylo ios:pod-refresh ``` Run it from your project root on macOS. Unlike `nylo clean --ios`, it doesn't run `flutter clean` or `flutter pub get`.

### Running Metro without the alias `nylo metro` passes everything after it to Metro (`dart run nylo_framework:main`). Use it before you've run `nylo init`, or on Windows, where `nylo init` can't add the `metro` alias for you: ``` bash nylo metro make:page settings_page nylo metro make:model User ```

### Updating the CLI ``` bash nylo self-update ``` This checks pub.dev and reinstalls `nylo_installer` if a newer version is available. After a command finishes, `nylo` also tells you when an update is out. It stays quiet when the output isn't going to a terminal, so the notice never ends up in CI logs or piped reports. To see which version you have installed: ``` bash nylo --version ```