Skip to main content
The Neo CLI provides powerful commands to streamline your Neo project development. Each command supports both interactive and flag-based usage for maximum flexibility.

​
Commands Overview

CommandDescription
neo createCreate a new Flutter project with Neo
neo configConfigure default CLI settings
neo helpDisplay help information
neo --versionShow CLI version

​
neo create

Create a new Flutter project using Neo with your preferred template and configuration.

​
Usage

neo create

​
Options

​
--name, -n
string
Name of the project to create. Must be a valid Flutter project name (lowercase, underscores allowed).
​
--org, -o
string
Organization identifier in reverse domain notation (e.g., com.example). Uses configured default if not specified.
​
--template, -t
string
Template to use for project creation. Available options: simple, sidebar. Uses configured default if not specified.
​
--platforms, -p
string
Comma-separated list of platforms to enable. Available: ios, android, web, macos, windows, linux. Uses configured default if not specified.

​
What Gets Created

The create command performs these steps automatically:
  1. Flutter Project Creation - Runs flutter create with optimized settings
  2. Neo Installation - Adds and configures the Neo package
  3. Template Setup - Applies your chosen template structure
  4. Dependencies - Installs all required packages
  5. Code Generation - Runs build runners for generated code
To explore available templates and choose the right one for your project, visit the Templates page.

​
neo config

Configure default settings that will be used for future project creation. After installing the Neo CLI, run this command to set up your preferences for organization identifier, default platforms, and preferred template.
Configuration only needs to be done once. You can re-run neo config anytime to update your settings.

​
Usage

neo config

​
Options

​
--list, -l
flag
Display all current configuration values.
​
--org, -o
string
Set the default organization identifier.
​
--template, -t
string
Set the default template.
​
--platforms, -p
string
Set the default enabled platforms (comma-separated).

​
neo help

Access comprehensive help information for any command.

​
Usage

neo help

​
Usage Patterns

​
Interactive vs Flag-Based

Interactive Mode (recommended for beginners):
  • Guides you through each step
  • Validates input in real-time
  • Uses your configured defaults
  • Perfect for learning and occasional use
Flag-Based Mode (recommended for advanced users):
  • Skip prompts for faster execution
  • Override defaults when needed
  • Ideal for automation and scripts
  • Consistent with CI/CD workflows

​
Automation Examples

#!/bin/bash
for app in app1 app2 app3; do
  neo create --name $app --org com.mycompany --template simple --platforms ios,android
done
⌘I