Filament Plugin CLI

https://github.com/jeffersongoncalves/filament-plugin-cli
Admin
Filament Plugin CLI is a Laravel Zero-based tool for non-interactively scaffolding new open-source...
Tokens:3,079
Snippets:37
Trust Score:9.8
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install filament-plugin-cli globally with Composer

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Installs the CLI globally via Composer. Requires PHP 8.2+ and Git.

```bash
composer global require jeffersongoncalves/filament-plugin-cli
```

--------------------------------

### Scaffold a single Filament 3 plugin branch

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Scaffolds a single starting branch targeting Filament 3 with default options (`--branch=1.x`, `--filament-version=3`).

```bash
filament-plugin create jeffersongoncalves/filament-settings "Runtime settings panel for Filament"
```

--------------------------------

### Update the CLI with filament-plugin self-update

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Updates the CLI to the latest release. The --check option only checks for updates without installing. This applies to PHAR installs only; Git/Composer installs must update via git pull or composer update.

```bash
filament-plugin self-update
filament-plugin self-update --check
```

--------------------------------

### Scaffold a single Filament 4 plugin branch

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Scaffolds a single branch that starts directly at Filament 4, for plugins that never supported v3.

```bash
filament-plugin create jeffersongoncalves/filament-settings "Runtime settings panel for Filament" --filament-version=4
```

--------------------------------

### Build filament-plugin CLI from source

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Clones the repository and builds the CLI locally. Run these commands in order to produce the `filament-plugin` binary.

```bash
git clone https://github.com/jeffersongoncalves/filament-plugin-cli.git
cd filament-plugin-cli
composer install
php filament-plugin app:build filament-plugin
```

--------------------------------

### Create plugin with custom keywords and dependencies

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Adds custom Composer keywords and an extra runtime dependency. The namespace is derived automatically from the package name.

```bash
filament-plugin create jeffersongoncalves/filament-ban "Ban and unban any Eloquent model from Filament tables" \
  --keywords="laravel,filament,filament-plugin,ban,bannable" \
  --require="cybercog/laravel-ban:^4.10"
```

--------------------------------

### Scaffold all branches from Filament 3 to 5

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Scaffolds every branch from Filament 3 through 5 in one go: `1.x`→v3, `2.x`→v4, `3.x`→v5. Branches are built sequentially (`2.x` off `1.x`, `3.x` off `2.x`).

```bash
filament-plugin create jeffersongoncalves/filament-settings "Runtime settings panel for Filament" --all-branches
```

--------------------------------

### Run tests with composer test

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Runs the test suite for the project.

```bash
composer test
```

--------------------------------

### Configure vendor namespace mapping in ~/.package/vendornamespace.json

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Configuration file at `~/.package/vendornamespace.json` that maps a vendor slug to a custom namespace. With this entry, `jeffersongoncalves/filament-ban` derives `JeffersonGoncalves\Filament\Ban` without flags. Lookups are per whole slug and case-insensitive; unlisted slugs fall back to studly.

```json
{
    "jeffersongoncalves": "JeffersonGoncalves"
}
```

--------------------------------

### Narrow all-branches range with --to-filament-version or --filament-version

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Narrows the branch range. The first command stops before v5 (only `1.x`→v3 and `2.x`→v4). The second skips v3 entirely (only `1.x`→v4 and `2.x`→v5).

```bash
filament-plugin create jeffersongoncalves/filament-settings "Runtime settings panel for Filament" --all-branches --to-filament-version=4
filament-plugin create jeffersongoncalves/filament-settings "Runtime settings panel for Filament" --all-branches --filament-version=4
```

--------------------------------

### Add a version branch to an existing plugin

Source: https://github.com/jeffersongoncalves/filament-plugin-cli/blob/main/README.md

Adds a version branch to an existing plugin repo. The existing `composer.json` is kept; only the `php`, `filament/filament` and `orchestra/testbench` constraints move.

```bash
filament-plugin branch jeffersongoncalves/filament-settings --branch=2.x --filament-version=4 --path=./filament-settings --from=1.x
```
Tokens:
Raw