Search by

naluz / installer

taliffsss

The NaluzPHP installer: create new NaluzPHP projects with `naluz new my-app`.

Package info

github.com/taliffsss/naluz-installer

pkg:composer/naluz/installer

Security

Advisories: 0

Aikido package health analysis

Transparency log

Statistics

Installs: 3

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v1.0.0 2026-10-02 03:29 UTC

Requires

  • php: ^8.2

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT 087300fef983c42179f7d43ec103275a41a2f4fe

  • Mark Anthony Naluz <anthony.naluz15.woop@gmail.com>

frameworkcliinstallernaluznaluzphp

Published on Packagist.org on 2026-10-02 03:29 UTC

This package is auto-updated.

Last update: 2026-10-02 03:33:27 UTC

README

The global command-line installer for NaluzPHP projects.

composer global require naluz/installer
naluz new my-app

Requires PHP 8.2+ and Composer. The installer itself has no dependencies.

Install

composer global require naluz/installer

Composer puts the naluz command in its global bin folder, which must be on your PATH. Find the folder with composer global config bin-dir --absolute.

Check it works:

naluz --version

naluz: command not found

The global bin folder is not on your PATH. Add the folder printed by composer global config bin-dir --absolute:

# macOS (zsh)           typical folder: ~/.composer/vendor/bin or ~/.config/composer/vendor/bin
echo 'export PATH="$PATH:$HOME/.composer/vendor/bin"' >> ~/.zshrc && source ~/.zshrc

# Linux (bash)          typical folder: ~/.config/composer/vendor/bin or ~/.composer/vendor/bin
echo 'export PATH="$PATH:$HOME/.config/composer/vendor/bin"' >> ~/.bashrc && source ~/.bashrc
# Windows (PowerShell)  typical folder: %APPDATA%\Composer\vendor\bin
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";$env:APPDATA\Composer\vendor\bin", "User")

Then open a new terminal and run naluz --version. More detail (fish, Git Bash, the Windows settings UI, troubleshooting): https://taliffsss.github.io/naluz-framework-docs/prologue/installation/#naluz-command-not-found

Update it with composer global update naluz/installer, and remove it with composer global remove naluz/installer.

Create a project

naluz new my-app
cd my-app
php naluz run:server

naluz new runs composer create-project for the NaluzPHP application skeleton, then:

  1. generates APP_KEY and JWT_SECRET in .env,
  2. creates the default SQLite database file (storage/database.sqlite),
  3. optionally runs the database migrations (it asks, or use --migrate),
  4. optionally initializes a Git repository (--git).
Option Meaning
--dir=PATH create the project inside PATH (default: the current directory)
--release=VERSION install a specific release, e.g. 1.2.0 or ^1.2 (default: the latest stable release)
--dev install the development version (dev-master)
--name=vendor/package set the Composer package name of the new project
--git run git init and make the first commit
--migrate run the migrations after installing, without asking
--no-install create the files only; run composer install yourself afterwards
--no-interaction never ask questions (also the default when there is no terminal) 
naluz new shop --name=acme/shop --migrate --git
naluz new . --dev                     # into the current (empty) directory
naluz new api --dir=~/Sites --release=^1.2

The target directory must not exist or must be empty. The installer never deletes anything.

Commands inside a project

Inside a NaluzPHP project (a folder with naluz and bootstrap/app.php), any other command is passed to the project's own naluz script, so these are equivalent:

naluz migrate         php naluz migrate
naluz make:model Post php naluz make:model Post
naluz                 php naluz list

naluz new and naluz --version always run the installer.

Security

  • The project name is validated ([A-Za-z0-9._-], no path separators, no ..), and so are --release and --name, so values cannot be turned into Composer options or paths.
  • Programs are started with an argument list, never through a shell, so nothing in a name is interpreted by sh.
  • The installer only forwards commands when the current directory really looks like a NaluzPHP project, and never executes unrelated files.
  • The skeleton (naluz/naluzphp) is installed by Composer from Packagist over HTTPS, with TLS verification and Composer's usual integrity checks.

Troubleshooting

Message Fix
Composer was not found install Composer, or set COMPOSER_BINARY to its path
The directory [...] is not empty choose another name, or empty the directory
Composer failed (exit code N) read Composer's output above it (network, PHP version or extension problems are the usual causes)
naluz: command not found add Composer's global bin directory to your PATH

Development

composer install
vendor/bin/phpunit
vendor/bin/phpcs
php bin/naluz list

Releases: put the version in .github/release-tag and merge to main; the Release workflow creates the tag and GitHub Release from releases/<tag>.md. Do not create tags by hand. See CHANGELOG.md.

License

MIT © Mark Anthony Naluz