Skip to main content
Before creating a Neo project, make sure you have the Neo CLI installed and configured.

​
Quick Start

The simplest way to create a new Neo project is to run the create command: 
neo create
The Neo CLI will guide you through an interactive setup process, asking for:
  • Project name (in snake_case format, e.g., my_awesome_app)
  • Template selection (if not configured)
  • Platform selection (if not configured)
  • Organization identifier (if not configured)
The Neo CLI uses your saved configuration for most settings, so you’ll typically only need to provide a project name after initial setup.

​
What Gets Created

When you run neo create, the Neo CLI automatically:
  1. Creates the Flutter project with optimized configuration
  2. Installs Neo and required dependencies
  3. Sets up the chosen template with boilerplate code
  4. Runs dependency installation (flutter pub get)
  5. Generates necessary files using build_runner
Your project will be ready for development immediately with all Neo components properly configured.

​
Project Templates

The Neo CLI provides multiple project templates to jumpstart your development. Each template includes pre-configured Neo setup, routing, theming, and follows best practices for scalable Flutter development.

Explore All Templates

Compare templates, see detailed features, and get guidance on choosing the right template for your project

​
Advanced Usage

For detailed information about all command options, flags, and advanced usage patterns, see the Commands & Options page.

​
Next Steps

Once your project is created:
  1. Open the project in your preferred IDE
  2. Explore the generated code to understand the structure
  3. Run the project with flutter run
  4. Start building with Neo’s widgets and layouts

Explore Widgets

Discover Neo’s pre-built components

Learn About Layouts

Master Neo’s layout system

​
Troubleshooting

Run the configuration command first to set up your defaults:
neo config
Install Flutter following the official Flutter installation guide.
If automatic code generation fails during project creation, you can run it manually:
cd your_project_name
dart run build_runner build --delete-conflicting-outputs
If dependency installation fails, try running:
cd your_project_name  
flutter pub get
The Neo CLI handles most error cases gracefully and will provide clear instructions for manual resolution when needed.
⌘I