Download the PHP package awcodes/filament-installer without Composer

Quickly spin up a new Filament powered application.

Filament Installer is a command-line tool that replaces the Laravel installer and wraps up the most common tasks you might take when creating a Filament app: opening it in your editor and your browser, initialize a git repository, tweak your .env and .env.example, and more.

Requirements

• PHP 8.0+
• (optional, but beneficial) Laravel Valet

Installation

Upgrading

Usage

Make sure ~/.composer/vendor/bin is in your terminal's path.

What exactly does it do?

• filament new $PROJECTNAME
• Initialize a git repo, add all the files, and, after some changes below, make a commit with the text "Initial commit."
• Replace the .env (and .env.example) database credentials with the default macOS MySQL credentials: database of $PROJECTNAME, user root, and empty password
• Replace the .env (and .env.example) APP_URL with $PROJECTNAME.$YOURVALETTLD
• Generate an app key
• Set up dark mode (if opted in)
• Scaffold custom theme assets (if opted in)
• Install and setup Filament Breezy, Filament Shield, or Filament Sentry (if opted in)
• Open the project in your favorite editor
• Open $PROJECTNAME.$YOURVALETTLD in your browser

Note: If your $PROJECTNAME has dashes (-) in it, they will be replaced with underscores (_) in the database name.

There are also a few optional behaviors based on the parameters you pass (or define in your config file), including creating a database, migrating, running Valet Link and/or Secure, and running a custom bash script of your definition after the fact.

Customizing Filament Installer

While the default actions Filament Installer provides are great, most users will want to customize at least a few of the steps. Thankfully, Filament Installer is built to be customized!

There are three ways to customize your usage of Filament Installer: command-line arguments, a config file, and an "after" file.

Most users will want to set their preferred configuration options once and then never think about it again. That's best solved by creating a config file.

But if you find yourself needing to change the way you interact with Filament Installer on a project-by-project basis, you may also want to use the command-line parameters to customize Filament Installer when you're using it.

Creating a config file

You can create a config file at ~/.filament/config rather than pass the same arguments each time you create a new project.

The following command creates the file, if it doesn't exist, and edits it:

The config file contains the configuration parameters you can customize, and will be read on every usage of Filament Installer.

Creating an "after" file

You can also create an after file at ~/.filament/after to run additional commands after you create a new project.

The following command creates the file, if it doesn't exist, and edits it:

The after file is interpreted as a bash script, so you can include any commands here, such as installing additional composer dependencies...

...or copying additional files to your new project.

You also have access to variables from your config file such as $PROJECTPATH and $CODEEDITOR.

Using command-line parameters

Any command-line parameters passed in will override Filament Installer's defaults and your config settings. See a full list of the parameters you can pass in.

Filament Installer Commands

• help or help-screen show the help screen

• edit-config edits your config file (and creates one if it doesn't exist)

• edit-after edits your "after" file (and creates one if it doesn't exist)

Configurable parameters

You can optionally pass one or more of these parameters every time you use Filament Installer. If you find yourself wanting to configure any of these settings every time you run Filament Installer, that's a perfect use for the config files.

• -e or --editor to define your editor command. Whatever is passed here will be run as $EDITOR . after creating the project.

• -p or --path to specify where to install the application.

• -m or --message to set the first Git commit message.

• -f or --force to force install even if the directory already exists

• -d or --dev to choose the develop branch instead of master, getting the beta install.

• -b or --browser to define which browser you want to open the project in.

• -l or --link to create a Valet link to the project directory.

• -s or --secure to secure the Valet site using https.

• --create-db to create a new MySQL database which has the same name as your project. This requires mysql command to be available on your system.

• --migrate-db to migrate your database.

• --dbuser to specify the database username.

• --dbpassword specify the database password.

• --dbhost specify the database host.

• --dark to use the Filament dark mode by default.

• --themed to scaffold out the assets needed for a custom Filament theme.

• --mix to revert Laravel to Laravel Mix instead of Vite

• --breezy to install and setup Filament Breezy (authentication plugin).

• --shield to install and setup Filament Shield (authorization plugin).

• --sentry to install and setup Filament Sentry (authentication, with Breezy, authorization, with Shield and Filament User Resources plugin).

• --full to use --create-db, --migrate-db, --link, and -secure.

  bash

  Repository created at https://github.com//my-cool-filament-app

  filament new my-cool-filament-app --github bash filament new my-cool-filament-app --github --gh-public bash filament Installer new my-cool-filament-app --github --gh-description='My cool Filament application' bash filament Installer new my-cool-filament-app --github --gh-homepage=https://example.com bash

  Repository created at https://github.com/acme/my-cool-filament-app

  filament new my-cool-filament-app --github --gh-org=acme