> ## Documentation Index
> Fetch the complete documentation index at: https://neo.tvk.company/llms.txt
> Use this file to discover all available pages before exploring further.

# Creating a Neo Project

> Create a new Neo project using the Neo CLI with templates and configuration options

<Info>
  Before creating a Neo project, make sure you have the [Neo CLI installed and configured](/install).
</Info>

## Quick Start

The simplest way to create a new Neo project is to run the create command:

```bash theme={null}
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)

<Note>
  The Neo CLI uses your saved configuration for most settings, so you'll typically only need to provide a project name after initial setup.
</Note>

## 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.

<Card title="Explore All Templates" icon="magnifying-glass" href="/cli/templates/">
  Compare templates, see detailed features, and get guidance on choosing the right template for your project
</Card>

## Advanced Usage

For detailed information about all command options, flags, and advanced usage patterns, see the [Commands & Options](/cli/commands) 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](/widgets/buttons/button) and [layouts](/layouts/sidebar)

<CardGroup cols={2}>
  <Card title="Explore Widgets" icon="grid-2" href="/widgets/buttons/button">
    Discover Neo's pre-built components
  </Card>

  <Card title="Learn About Layouts" icon="table-layout" href="/layouts/sidebar">
    Master Neo's layout system
  </Card>
</CardGroup>

<Tip>
  Enhance your development experience by setting up the [Neo Docs MCP](/neo-docs-mcp) server. Your AI assistant will have direct access to Neo's documentation, making it easier to use widgets, build screens, and handle breaking changes automatically.
</Tip>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Error: &#x22;Neo CLI is not configured&#x22;">
    Run the configuration command first to set up your defaults:

    ```bash theme={null}
    neo config
    ```
  </Accordion>

  <Accordion title="Error: &#x22;Flutter is not installed&#x22;">
    Install Flutter following the [official Flutter installation guide](https://flutter.dev/docs/get-started/install).
  </Accordion>

  <Accordion title="Code generation fails">
    If automatic code generation fails during project creation, you can run it manually:

    ```bash theme={null}
    cd your_project_name
    dart run build_runner build --delete-conflicting-outputs
    ```
  </Accordion>

  <Accordion title="Package installation issues">
    If dependency installation fails, try running:

    ```bash theme={null}
    cd your_project_name  
    flutter pub get
    ```
  </Accordion>
</AccordionGroup>

<Note>
  The Neo CLI handles most error cases gracefully and will provide clear instructions for manual resolution when needed.
</Note>