Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nativecli.com/llms.txt

Use this file to discover all available pages before exploring further.

The new command is probably the first one you’ll ever use. This command will install Laravel into the provided directory name and then install NativePHP, ready to go for you.

​
Install & Run

By default, nativecli new will:
  1. Create a Laravel project.
  2. Install either nativephp/desktop or nativephp/mobile.
  3. Run php artisan native:install.
  4. Prompt to run php artisan native:run.
If you prefer to skip install and run, use --jump to run php artisan native:jump instead.

​
Command

Syntax: 
nativecli new <directory-name>

​
Options

​
—mobile

Indicates whether the project should be set up with NativePHP for Mobile, instead of Desktop.

​
—jump

Run native:jump and skip the install and run flow.

​
—dev

Installs the latest “development” release.

​
—git

Initialize a Git repository.

​
—branch

The branch that should be created for a new repository (default: main).

​
—github

Create a new repository on GitHub.

​
—organization

The GitHub organization to create the new repository for.

​
—database

The database driver your application will use.

​
—react

Install the React Starter Kit

​
—vue

Install the Vue Starter Kit

​
—livewire

Install the Livewire Starter Kit

​
—livewire-class-components

Generate stand-alone Livewire class components

​
—workos

Use WorkOS for authentication

​
—pest

Installs the Pest testing framework.

​
—phpunit

Installs the PHPUnit testing framework.

​
—npm

Install and build NPM dependencies

​
—using

Install a custom starter kit from a community maintained package

​
—force, -f

Forces install even if the directory already exists.

​
Example

Create a new project with Vue and Pest: 
nativecli new MyProject --vue --pest
Create a new project and jump straight into NativePHP Jump: 
nativecli new MyProject --jump