Filakit CLI

• Requirements
• Installation
  • Download PHAR (recommended)
  • Via Composer (global)
• Usage
  • Interactive mode
  • With arguments
  • Skip selection with --kit
  • Additional Options
• Available Starter Kits
  • Filament v5
  • Filament v4
  • Filament v3
• How It Works
• Development
• License

CLI tool for scaffolding Laravel projects with Filakit starter kits. Select from available starter kits and create a new Laravel application with a single command.

#Requirements

• PHP >= 8.2
• Laravel Installer (composer global require laravel/installer)

#Installation

#Download PHAR (recommended)

Download the latest filakit.phar from the Releases page:

# Download and make executable
curl -sL https://github.com/jeffersongoncalves/filakit-cli/releases/latest/download/filakit.phar -o filakit
chmod +x filakit
sudo mv filakit /usr/local/bin/filakit

#Via Composer (global)

composer global require jeffersongoncalves/filakit-cli

#Usage

#Interactive mode

filakit new

The CLI will prompt you for:

1. Application name - the name of your new project
2. Starter kit - select from the available kits

#With arguments

filakit new my-app

#Skip selection with --kit

filakit new my-app --kit=jeffersongoncalves/filakitv5

#Additional Options

All options from the Laravel installer are supported and forwarded directly:

Examples:

# Create with Git + Pest + pnpm
filakit new my-app --kit=jeffersongoncalves/filakitv5 --git --pest --pnpm

# Create with a GitHub repo under an organization
filakit new my-app --kit=jeffersongoncalves/filakitv5 --github=private --organization=my-org

# Force overwrite with a specific database
filakit new my-app --kit=jeffersongoncalves/filakitv5 --database=pgsql --force

#Available Starter Kits

#Filament v5

#Filament v4

#Filament v3

#How It Works

Under the hood, Filakit CLI runs laravel new with the --using flag:

laravel new my-app --using=jeffersongoncalves/filakitv5

The list of available starter kits is embedded in the CLI and automatically updated via GitHub Actions when the source list changes.

#Development

# Clone
git clone git@github.com:jeffersongoncalves/filakit-cli.git
cd filakit-cli

# Install dependencies
composer install

# Run tests
php vendor/bin/pest

# Run code formatting
php vendor/bin/pint

# Build PHAR
php filakit app:build filakit

#License

Filakit CLI is open-source software licensed under the MIT license.