ionic start

Contents

Create a new project

ionic start <name> <template> [options]

This command creates a working Ionic app. It installs dependencies for you and sets up your project.

Running ionic start without any arguments will prompt you for information about your new project.

The first argument is your app's name. Don't worry--you can always change this later. The --project-id is generated from name unless explicitly specified.

The second argument is the template from which to generate your app. You can list all templates with the --list option. You can also specify a git repository URL for template, in which case the existing project will be cloned.

Use the --type option to start projects using older versions of Ionic. For example, you can start an Ionic 3 project with --type=ionic-angular. Use --list to see all project types and templates.

Examples

ionic start ionic start --listionic start myAppionic start myApp blankionic start myApp tabs --cordovaionic start myApp tabs --capacitorionic start myApp super --type=ionic-angularionic start myApp blank --type=ionic1ionic start cordovaApp tabs --cordovaionic start "My App" blankionic start "Conference App" https://github.com/ionic-team/ionic-conference-app

Inputs

name

Description

The name of your new project (e.g. myApp, "My App")

template

Description

The starter template to use (e.g. blank, tabs; use --list to see all)

Options

--list

Description

List available starter templates

Aliases-l

--type=<type>

Description

Type of project to start (e.g. angular, ionic-angular, ionic1)

--cordova

Description

Include Cordova integration

--capacitor

Description

Include Capacitor integration

--id=<id>

Description

Specify an app ID from the Ionic Appflow to link

--pro-id=<id>

Description

Use the --id option

Advanced Options

--no-deps

Description

Do not install npm/yarn dependencies

--no-git

Description

Do not initialize a git repo

--no-link

Description

Do not ask to connect the app to Ionic Appflow

--project-id=<slug>

Description

Specify a slug for your app (used for the directory name and npm/yarn package name)

--package-id=<id>

Description

Specify the bundle ID/application ID for your app (reverse-DNS notation)