Laravel Valet

https://github.com/laravel/valet
Admin
A blazing fast Laravel development environment for Mac that uses Nginx and DnsMasq to enable local...
Tokens:121,355
Snippets:935
Trust Score:9.7
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Usage example

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Nginx.md

Shows how to resolve and use the Nginx class for install, restart, and stop operations.

```php
use Valet\Nginx;

$nginx = resolve(Nginx::class);

$nginx->install();                 // full install (config + server + site dir)
$nginx->restart();                 // lint, then restart the service — throws DomainException on bad config
$nginx->stop();
```

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

### installOrFail

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Installs a Homebrew formula, tapping repositories and running the install command as the user. Throws an exception if installation fails.

```APIDOC
## installOrFail

### Description
Taps `$taps` (as user), maps limited versions to `shivammathur/php/{formula}`, runs `HOMEBREW_NO_INSTALL_CLEANUP=1 brew install {formula} {options}` as user. **Throws `DomainException`** ("Brew was unable to install [{formula}].") when the command exits non-zero.

### Method
installOrFail

### Signature
`installOrFail(string $formula, array $options = [], array $taps = []): void`

### Parameters
- **$formula** (string) - Required - The Homebrew formula name.
- **$options** (array) - Optional - Additional options for the install command.
- **$taps** (array) - Optional - Taps to add before installation.

### Exceptions
- **DomainException** - Thrown when the install command fails.
```

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

### Usage example for Composer

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Composer.md

Usage example: resolves the Composer class, checks if 'beyondcode/expose' is installed, prints its version if so, otherwise installs it (which may throw DomainException).

```php
use Valet\Composer;

$composer = resolve(Composer::class);

if ($composer->installed('beyondcode/expose')) {
    echo $composer->installedVersion('beyondcode/expose');
} else {
    $composer->installOrFail('beyondcode/expose');   // may throw DomainException
}
```

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

### install(): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Nginx.md

Installs Nginx via Brew and sets up the configuration, server, and Nginx directory.

```APIDOC
## install(): void

### Description
Ensures Nginx is installed via Brew, then installs the configuration, server, and Nginx directory.

### Method
install

### Parameters
None

### Return Value
void

### Example
```php
$nginx->install();
```
```

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

### Usage example for DnsMasq

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/DnsMasq.md

Shows how to resolve the DnsMasq class and call install, updateTld, refreshConfiguration, and restart methods.

```php
use Valet\DnsMasq;

$dnsmasq = resolve(DnsMasq::class);

$dnsmasq->install('test');             // configure .test resolution
$dnsmasq->updateTld('test', 'dev');    // migrate to a new TLD
$dnsmasq->refreshConfiguration();      // re-apply config after loopback change
$dnsmasq->restart();
```

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

### Usage example for Brew class

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Shows how to resolve the Brew class, ensure PHP is installed, get the PHP executable path, and retrieve the linked PHP version. The linkedPhp method throws a DomainException if PHP is unlinked.

```php
use Valet\Brew;

$brew = resolve(Brew::class);

if (! $brew->hasInstalledPhp()) {
    $brew->ensureInstalled('php', [], $brew->taps ?? []);   // PhpFpm supplies the taps normally
}

echo $brew->getPhpExecutablePath('php@8.2');                // /opt/homebrew/opt/php@8.2/bin/php
echo $brew->linkedPhp();                                    // e.g. "php@8.2" — throws DomainException if unlinked
```

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

### install(string $tld = 'test'): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/DnsMasq.md

Installs and configures DnsMasq for the given TLD. Ensures dnsmasq is installed, creates the necessary configuration files, and restarts the service.

```APIDOC
## install(string $tld = 'test'): void

### Description
Installs and configures DnsMasq for the given TLD. Ensures dnsmasq is installed, creates the necessary configuration files, and restarts the service.

### Method
install

### Parameters
- **$tld** (string) - Optional - Default: `test` - The top-level domain to serve.

### Returns
void

### Example
```php
$dnsmasq->install('test');
```
```

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

### Error handling for installOrFail

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Composer.md

Error handling example: wraps installOrFail in a try-catch for DomainException, showing the exception message and a manual installation warning.

```php
try {
    $composer->installOrFail('beyondcode/expose');
} catch (DomainException $e) {
    // "Composer was unable to install [beyondcode/expose]."
    warning('Install Expose manually: composer global require beyondcode/expose');
}
```

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

### Usage example of Valet\Configuration

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Configuration.md

Demonstrates using the Valet\Configuration facade to add a path, read the current configuration, update a key, and remove a path.

```php
use Valet\Configuration;

$config = resolve(Configuration::class);

$config->addPath('/Users/me/Code');
$current = $config->read();                    // ['tld' => 'test', 'loopback' => '127.0.0.1', 'paths' => [...]]
$config->updateKey('tld', 'test');             // setter; returns updated array
$config->removePath('/Users/me/OldCode');
```

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

### hasInstalledNginx(): bool

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Checks if either nginx or nginx-full is installed.

```APIDOC
## hasInstalledNginx(): bool

### Description
Returns true if `nginx` or `nginx-full` is installed.

### Method
hasInstalledNginx

### Parameters
None

### Return Value
- (bool) - True if nginx or nginx-full is installed, false otherwise.

```

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

### configuredSites method

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Nginx.md

Returns a collection of all file names in ~/.config/valet/Nginx that do not start with a dot.

```php
public function configuredSites(): Collection
```

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

### Cloudflared::ensureInstalled

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/ShareTools.md

Installs the cloudflared binary via Homebrew if it is not already installed.

```APIDOC
## ensureInstalled(): void

### Description
Installs the `cloudflared` binary via Homebrew if it is not already installed.

### Method
ensureInstalled

### Signature
`ensureInstalled(): void`

### Return Value
- **void** - No return value.
```

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

### ensureInstalled

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Installs a Homebrew formula only if it is not already installed.

```APIDOC
## ensureInstalled

### Description
Installs via `installOrFail` only when not installed.

### Method
ensureInstalled

### Signature
`ensureInstalled(string $formula, array $options = [], array $taps = []): void`

### Parameters
- **$formula** (string) - Required - The Homebrew formula name.
- **$options** (array) - Optional - Additional options for the install command.
- **$taps** (array) - Optional - Taps to add before installation.

### Return Value
void
```

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

### Expose::ensureInstalled

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/ShareTools.md

Installs the beyondcode/expose package if it is not already installed.

```APIDOC
## ensureInstalled(): void

### Description
Installs the `beyondcode/expose` package via Composer if it is not already installed.

### Method
ensureInstalled

### Signature
`ensureInstalled(): void`

### Return Value
- **void** - No return value.
```

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

### installOrFail(string $namespacedPackage): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Composer.md

Installs a global Composer package by running `composer global require {package}` as the user. Throws a DomainException if the command fails.

```APIDOC
## installOrFail(string $namespacedPackage): void

### Description
Installs a global Composer package by running `composer global require {package}` as the user. Throws a DomainException if the command fails.

### Method
installOrFail

### Signature
```php
public function installOrFail(string $namespacedPackage): void
```

### Parameters
- **$namespacedPackage** (string) - Required - Fully-qualified package name, e.g. `beyondcode/expose`.

### Exceptions
- **DomainException** - Thrown when the command exits non-zero, with message "Composer was unable to install [{package}]."

```

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

### Usage example of CommandLine methods

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/CommandLine.md

Shows how to resolve the CommandLine class and use runAsUser, quietly, and passthru methods. runAsUser runs as the real user, quietly runs as root silently, and passthru runs interactively.

```php
use Valet\CommandLine;

$cli = resolve(CommandLine::class);

$version = $cli->runAsUser('openssl version');               // runs as the real user
$cli->quietly('sudo rm -f /tmp/valet.sock');                 // root, silent
$cli->passthru('tail -f ~/.config/valet/Log/nginx-error.log'); // interactive
```

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

### Composer::installedVersion()

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Composer.md

Returns the first installed version string from `$details['versions']` or null when the package is not installed. Similar to `installed()` but returns the version instead of a boolean.

```php
public function installedVersion(string $namespacedPackage): ?string
{
    $result = $this->cli->runAsUser("composer global show --format json -- $namespacedPackage");

    if (str_contains($result, 'InvalidArgumentException') && str_contains($result, 'not found')) {
        return null;
    }

    if (starts_with($result, 'Changed current')) {
        $result = strstr($result, '{');
    }

    $details = json_decode($result, true);
    $versions = $details['versions'];

    return reset($versions);
}
```

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

### trustCa(string $caPemPath): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Site.md

Installs the CA certificate in the System keychain. Throws DomainException on failure.

```APIDOC
## trustCa(string $caPemPath): void

### Description
Runs `sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain "{caPemPath}"`; **throws `DomainException`** ("The Certificate Authority must be trusted…") on failure.

### Method
trustCa

### Parameters
- `$caPemPath` (string) - Required - Path to the CA PEM file.

### Returns
void

### Exceptions
- `DomainException` - If the CA cannot be trusted.
```

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

### PhpFpm::install()

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/PhpFpm.md

Installs the latest PHP version via Homebrew, creates configuration files for all utilized PHP versions, removes stale socket files, restarts PHP-FPM, and symlinks the primary Valet socket.

```APIDOC
## PhpFpm::install()

### Description
Ensures the latest PHP version is installed via Homebrew with the configured taps, creates configuration files for all utilized PHP versions, removes stale socket files, restarts PHP-FPM, and symlinks the primary Valet socket.

### Method
install

### Signature
```php
public function install(): void
```

### Behavior
1. Ensures `php` (latest) is installed via Brew with `$taps`.
2. Ensures `~/.config/valet/Log` directory exists.
3. Runs `createConfigurationFiles()` for every utilized PHP version.
4. Removes stale `~/.config/valet/valet.sock` (user + sudo).
5. Restarts PHP-FPM.
6. Symlinks the primary Valet socket for the linked PHP version.

### Returns
void
```

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

### Configuration::install method signature

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Configuration.md

Method signature for installing the Valet home directory structure. Creates configuration, Drivers, Sites, Log, and Certificates directories, then ensures base configuration is present.

```php
public function install(): void
```

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

### Composer::installOrFail()

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Composer.md

Runs `composer global require {package}` as the user. Throws DomainException with message "Composer was unable to install [{package}]." when the command exits non-zero.

```php
public function installOrFail(string $namespacedPackage): void
```

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

### Ngrok::ensureInstalled

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/ShareTools.md

Ensures Ngrok is installed via Homebrew.

```APIDOC
## ensureInstalled(): void

### Description
Ensures Ngrok is installed by delegating to `$brew->ensureInstalled('ngrok')`.

### Method
ensureInstalled

### Endpoint
N/A (PHP method)

### Parameters
None

### Return Value
- **void** - No return value.
```

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

### trustCertificate(string $crtPath): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Site.md

Installs a site certificate in the System keychain with trustAsRoot.

```APIDOC
## trustCertificate(string $crtPath): void

### Description
Same Keychain install with `-r trustAsRoot` for a site certificate.

### Method
trustCertificate

### Parameters
- `$crtPath` (string) - Required - Path to the certificate file.

### Returns
void
```

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

### installedVersion(string $namespacedPackage): ?string

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Composer.md

Returns the first installed version of a global Composer package, or null if the package is not installed. Uses `composer global show --format json -- {package}`.

```APIDOC
## installedVersion(string $namespacedPackage): ?string

### Description
Returns the first installed version of a global Composer package, or null if the package is not installed. Uses `composer global show --format json -- {package}`.

### Method
installedVersion

### Signature
```php
public function installedVersion(string $namespacedPackage): ?string
```

### Parameters
- **$namespacedPackage** (string) - Required - Fully-qualified package name, e.g. `beyondcode/expose`.

### Return Value
- **?string** - The first installed version string, or `null` if the package is not installed.

```

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

### symlinkToUsersBin(): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Valet.md

Creates a symlink from the Valet repository to the user bin path. Used by the install command.

```APIDOC
## symlinkToUsersBin(): void

### Description
Removes any existing `$valetBin` and then runs `ln -s "<repo>/valet" <$valetBin>` as the non-root user. Used by the `install` command.

### Method
PHP Method

### Signature
```php
public function symlinkToUsersBin(): void
```

### Parameters
None.

### Return Type
void
```

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

### installedPhpFormulae(): Collection

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Lists installed PHP formulae from brew list, stripping tap prefixes.

```APIDOC
## installedPhpFormulae(): Collection

### Description
Runs `brew list --formula | grep php` and strips tap prefix via `formulaName()`.

### Method
installedPhpFormulae

### Parameters
None

### Return Value
- (Collection) - Collection of installed PHP formula names.

```

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

### useVersion(string $version, bool $force = false): ?string

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/PhpFpm.md

Switches the global PHP version. Validates, installs, links, and restarts services. Exits if already on the version unless force is true.

```APIDOC
## useVersion(string $version, bool $force = false): ?string

### Description
Switches the global PHP version to the specified version. Validates the version, ensures it is installed, unlinks the current linked formula, links the new version, stops running PHP, re-runs install(), restarts Nginx, and prints guidance about composer global update. If the version already matches and force is false, it calls exit() with a message. Returns the new version string (possibly aliased).

### Method
useVersion

### Endpoint
useVersion(string $version, bool $force = false): ?string

### Parameters
#### Path Parameters
- **$version** (string) - Required - The PHP version to switch to, e.g. php@8.2.
- **$force** (bool) - Optional - Default: false. Re-link even when already on the version.

### Response
#### Success Response
- **?string** - The new version string, or null if not applicable.

#### Response Example
"php@8.2"
```

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

### ensureInstalled

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Ensures a given formula (e.g., PHP) is installed via Homebrew, optionally with additional arguments and taps.

```APIDOC
## ensureInstalled($formula, $options = [], $taps = [])

### Description
Ensures the specified Homebrew formula is installed. If not installed, it will install it with the given options and taps.

### Method
ensureInstalled

### Signature
`ensureInstalled(string $formula, array $options = [], array $taps = []): void`

### Parameters
- **$formula** (string) - Required - The Homebrew formula name (e.g., 'php').
- **$options** (array) - Optional - Additional options to pass to the install command.
- **$taps** (array) - Optional - Additional taps to use.

### Return Value
void

### Example
```php
$brew->ensureInstalled('php', [], $brew->taps ?? []);
```
```

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

### Using onLatestVersion to check for updates

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Valet.md

Example usage of onLatestVersion to check if the local version is up-to-date. Resolves the Valet service and calls the method with a sample version string.

```php
use Valet\Valet;

if (! resolve(Valet::class)->onLatestVersion('4.12.0')) {
    // prompt the user to upgrade
}
```

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

### hasInstalledPhp(): bool

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Determines if any supported PHP formula is installed.

```APIDOC
## hasInstalledPhp(): bool

### Description
Returns true if any installed formula is in `supportedPhpVersions()`.

### Method
hasInstalledPhp

### Parameters
None

### Return Value
- (bool) - True if any supported PHP version is installed, false otherwise.

```

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

### nginxServiceName(): string

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Returns the service name for nginx, preferring nginx-full if installed.

```APIDOC
## nginxServiceName(): string

### Description
Returns `nginx-full` when installed, else `nginx`.

### Method
nginxServiceName

### Parameters
None

### Return Value
- (string) - The nginx service name.

```

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

### Usage example for Diagnose

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Diagnose.md

Shows how to resolve the Diagnose class and call its run method, as done by the valet diagnose command. The run method copies diagnostics HTML to the clipboard via pbcopy.

```php
use Valet\Diagnose;

$diagnose = resolve(Diagnose::class);

// The `valet diagnose` command (cli/app.php) does:
$diagnose->run($print = false, $plain = false);
// => diagnostics HTML is copied to the clipboard (pbcopy)
```

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

### Valet constructor with $valetBin property

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Valet.md

Constructor and promoted property for the Valet service. $valetBin is the install target at {BREW_PREFIX}/bin/valet. Both $cli and $files are required dependencies.

```php
public string $valetBin = BREW_PREFIX.'/bin/valet';

public function __construct(public CommandLine $cli, public Filesystem $files) {}
```

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

### symlinkToUsersBin method signature

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Valet.md

Removes any existing $valetBin and creates a symlink from the repository's valet script to $valetBin. Used by the install command.

```php
public function symlinkToUsersBin(): void
```

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

### Usage: call Upgrader::onEveryRun()

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Upgrader.md

Usage example. Import the Valet\Upgrader class and invoke onEveryRun() as done in cli/app.php. Note that the upgrader may terminate the process on unmigratable states.

```php
use Valet\Upgrader;

// Called automatically by cli/app.php before the console app runs:
Upgrader::onEveryRun();
```

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

### installServer(): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Nginx.md

Ensures the Nginx valet directory exists and writes the default server configuration and fastcgi_params.

```APIDOC
## installServer(): void

### Description
Ensures `{BREW_PREFIX}/etc/nginx/valet` exists and writes `valet/valet.conf` (the default server that rewrites to server.php) and `fastcgi_params` from stubs.

### Method
installServer

### Parameters
None

### Return Value
void

### Example
```php
$nginx->installServer();
```
```

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

### installConfiguration(): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Nginx.md

Writes the main nginx.conf file from a stub with user and home path substitutions.

```APIDOC
## installConfiguration(): void

### Description
Writes `{BREW_PREFIX}/etc/nginx/nginx.conf` from the `nginx.conf` stub, substituting `VALET_USER` with the current user and `VALET_HOME_PATH` with the Valet home path.

### Method
installConfiguration

### Parameters
None

### Return Value
void

### Example
```php
$nginx->installConfiguration();
```
```

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

### Constructor

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Valet.md

Initializes the Valet service with a CommandLine and Filesystem instance.

```APIDOC
## Constructor

### Description
Initializes the Valet service with the provided CommandLine and Filesystem instances.

### Signature
```php
public function __construct(public CommandLine $cli, public Filesystem $files) {}
```

### Parameters
- **$cli** (Valet\CommandLine) - Required - Process execution wrapper.
- **$files** (Valet\Filesystem) - Required - File-system wrapper.

### Properties
- **$valetBin** (string) - The install target `{BREW_PREFIX}/bin/valet`.
```

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

### Basic Server Usage

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Server.md

Shows how to instantiate the Server class and use its methods to resolve the site path from the request. If no site path is found, it calls Server::show404() which responds with a 404 and exits.

```php
use Valet\Server;

$server = new Server($config); // $config = json_decode(file_get_contents('~/.config/valet/config.json'), true)

$uri = Server::uriFromRequestUri($_SERVER['REQUEST_URI']);
$siteName = $server->siteNameFromHttpHost($_SERVER['HTTP_HOST']); // "my-site" from "www.my-site.test"
$sitePath = $server->sitePath($siteName) ?? $server->defaultSitePath();

if (is_null($sitePath)) {
    Server::show404(); // responds 404 and exits
}
```

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

### Expose::installedVersion

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/ShareTools.md

Returns the installed version of the beyondcode/expose package, or null if not installed.

```APIDOC
## installedVersion(): ?string

### Description
Returns the installed version of the `beyondcode/expose` package via Composer.

### Method
installedVersion

### Signature
`installedVersion(): ?string`

### Return Value
- **?string** - The installed version string, or null if not installed.
```

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

### Usage example: checking Valet status

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Status.md

Example of using the Status class to check health and output results or debug instructions.

```php
use Valet\Status;

$status = resolve(Status::class)->check();

if ($status['success']) {
    echo "Valet status: Healthy\n";
} else {
    foreach ($status['output'] as $row) {
        printf("%s => %s\n", $row['description'], $row['success']);
    }
    echo $status['debug'];
}
```

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

### Basic Filesystem Usage with Valet\Filesystem

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Filesystem.md

Resolves the Filesystem class and demonstrates common operations: ensuring a directory exists, writing a config file as the user, creating a symlink as the user, and changing ownership.

```php
use Valet\Filesystem;

$files = resolve(Filesystem::class);

$files->ensureDirExists('/Users/me/.config/valet/Certificates', user());
$files->putAsUser('/Users/me/.config/valet/config.json', '{"tld":"test"}');
$files->symlinkAsUser('/Users/me/Code/app', '/Users/me/.config/valet/Sites/app');
$files->chown('/Users/me/.config/valet/config.json', 'me');
```

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

### installed(string $formula): bool

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Checks if a given Homebrew formula or cask is installed, either via brew info or by checking for a keg in the Cellar.

```APIDOC
## installed(string $formula): bool

### Description
Returns true when the formula/cask is installed per `brew info`, or a keg exists in the Cellar (`hasInstalledKeg`).

### Method
installed

### Parameters
- `$formula` (string) - Required - The name of the Homebrew formula or cask to check.

### Return Value
- (bool) - True if the formula/cask is installed, false otherwise.

```

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

### hasInstalledPhp

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Checks if PHP is installed via Homebrew.

```APIDOC
## hasInstalledPhp()

### Description
Checks whether PHP is installed via Homebrew.

### Method
hasInstalledPhp

### Signature
`hasInstalledPhp(): bool`

### Parameters
None

### Return Value
bool - True if PHP is installed, false otherwise.

### Example
```php
if (! $brew->hasInstalledPhp()) {
    // ...
}
```
```

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

### installNginxDirectory(): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Nginx.md

Ensures the user's Nginx directory exists and rewrites secure Nginx files.

```APIDOC
## installNginxDirectory(): void

### Description
Ensures `~/.config/valet/Nginx` exists, writes a `.keep` file, and then calls `rewriteSecureNginxFiles()`.

### Method
installNginxDirectory

### Parameters
None

### Return Value
void

### Example
```php
$nginx->installNginxDirectory();
```
```

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

### installed(string $namespacedPackage): bool

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Composer.md

Checks if a global Composer package is installed by running `composer global show --format json -- {package}` as the user. Returns false if the package is not found, otherwise true if the decoded JSON is non-empty.

```APIDOC
## installed(string $namespacedPackage): bool

### Description
Checks if a global Composer package is installed by running `composer global show --format json -- {package}` as the user. Returns false if the package is not found, otherwise true if the decoded JSON is non-empty.

### Method
installed

### Signature
```php
public function installed(string $namespacedPackage): bool
```

### Parameters
- **$namespacedPackage** (string) - Required - Fully-qualified package name, e.g. `beyondcode/expose`.

### Return Value
- **bool** - `true` if the package is installed, `false` otherwise. Never throws.

```

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

### Static method: showDirectoryListing(string $valetSitePath, string $uri)

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Server.md

Serves an HTML index of the given directory, sorting directories first in natural case-insensitive order. Calls show404() if the directory does not exist. Echoes links and exits.

```php
public static function showDirectoryListing(string $valetSitePath, string $uri)
```

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

### uninstallText(): string

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Valet.md

Returns the manual uninstall instructions shown when `valet uninstall` is run without `--force`.

```APIDOC
## uninstallText(): string

### Description
Returns the manual uninstall instructions shown when `valet uninstall` is run without `--force` (certificate cleanup, config removal, composer removal, Homebrew uninstall, troubleshooting). Contains console markup tags.

### Method
PHP Method

### Signature
```php
public function uninstallText(): string
```

### Parameters
None.

### Return Type
string - The uninstall instructions.
```

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

### starts_with

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/overview.md

Checks if a string starts with one of the given needles.

```APIDOC
## starts_with

### Description
String helper to check if a haystack starts with any of the given needles.

### Signature
`function starts_with(string $haystack, array|string $needles): bool`

### Parameters
- **$haystack** (string) - Required - The string to search in.
- **$needles** (array|string) - Required - The needle(s) to search for.

### Returns
- **bool** - True if the haystack starts with any needle.
```

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

### Ngrok::installed

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/ShareTools.md

Checks whether Ngrok is installed via Homebrew.

```APIDOC
## installed(): bool

### Description
Returns `true` if Ngrok is installed, by delegating to `$brew->installed('ngrok')`.

### Method
installed

### Endpoint
N/A (PHP method)

### Parameters
None

### Return Value
- **bool** - `true` if Ngrok is installed, `false` otherwise.
```

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

### Nginx constructor

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Nginx.md

Initializes the Nginx class with dependencies for Brew, CommandLine, Filesystem, Configuration, and Site.

```php
public function __construct(public Brew $brew, public CommandLine $cli, public Filesystem $files,
    public Configuration $configuration, public Site $site) {}
```

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

### Cloudflared::installed

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/ShareTools.md

Checks whether the cloudflared binary is installed via Homebrew.

```APIDOC
## installed(): bool

### Description
Returns true if the `cloudflared` binary is installed via Homebrew, otherwise false.

### Method
installed

### Signature
`installed(): bool`

### Return Value
- **bool** - True if installed, false otherwise.
```

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

### Expose::installed

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/ShareTools.md

Checks whether the beyondcode/expose package is installed via Composer.

```APIDOC
## installed(): bool

### Description
Returns true if the `beyondcode/expose` package is installed, otherwise false.

### Method
installed

### Signature
`installed(): bool`

### Return Value
- **bool** - True if installed, false otherwise.
```

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

### restart method

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Nginx.md

Runs lint() then restarts the Nginx service via Brew.

```php
public function restart(): void
```

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

### hasLinkedPhp(): bool

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Returns true when {BREW_PREFIX}/bin/php is a symlink, indicating a linked PHP installation.

```APIDOC
## hasLinkedPhp(): bool

### Description
Returns true when `{BREW_PREFIX}/bin/php` is a symlink, indicating a linked PHP installation.

### Method
hasLinkedPhp

### Return Type
bool

### Returns
- **bool** - True if the PHP binary is a symlink, false otherwise.
```

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

### Filesystem Class Methods

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Filesystem.md

All public methods of the Valet\Filesystem class, including signatures and descriptions.

```APIDOC
## Filesystem Class

### Description
Thin, user-sensitive wrapper over PHP file-system built-ins. Most mutating operations have an `...AsUser` variant that performs the operation then `chown`s the target to `user()` (the sudo-invoking user). Facade: global `Filesystem`.

### Methods

#### isDir
- **Signature**: `isDir(string $path): bool`
- **Description**: `is_dir($path)`.

#### mkdir
- **Signature**: `mkdir(string $path, ?string $owner = null, int $mode = 0755): void`
- **Description**: Recursive mkdir + optional `chown`.

#### ensureDirExists
- **Signature**: `ensureDirExists(string $path, ?string $owner = null, int $mode = 0755): void`
- **Description**: Create only when missing.

#### mkdirAsUser
- **Signature**: `mkdirAsUser(string $path, int $mode = 0755): void`
- **Description**: `mkdir($path, user(), $mode)`.

#### touch
- **Signature**: `touch(string $path, ?string $owner = null): string`
- **Description**: Create/update mtime; returns `$path`.

#### touchAsUser
- **Signature**: `touchAsUser(string $path): string`
- **Description**: `touch($path, user())`.

#### exists
- **Signature**: `exists(string $path): bool`
- **Description**: `file_exists($path)`.

#### get
- **Signature**: `get(string $path): string`
- **Description**: `file_get_contents($path)`.

#### put
- **Signature**: `put(string $path, string $contents, ?string $owner = null): void`
- **Description**: `file_put_contents($path, $contents)` + chown.

#### putAsUser
- **Signature**: `putAsUser(string $path, ?string $contents): void`
- **Description**: `put($path, $contents, user())`.

#### append
- **Signature**: `append(string $path, string $contents, ?string $owner = null): void`
- **Description**: Append mode write + chown.

#### appendAsUser
- **Signature**: `appendAsUser(string $path, string $contents): void`
- **Description**: `append($path, $contents, user())`.

#### copy
- **Signature**: `copy(string $from, string $to): void`
- **Description**: File copy.

#### copyAsUser
- **Signature**: `copyAsUser(string $from, string $to): void`
- **Description**: Copy + chown destination.

#### symlink
- **Signature**: `symlink(string $target, string $link): void`
- **Description**: Unlinks an existing link, then `symlink($target, $link)`.

#### symlinkAsUser
- **Signature**: `symlinkAsUser(string $target, string $link): void`
- **Description**: Same, but via `CommandLine::runAsUser('ln -s …')` because PHP cannot change symlink permissions.

#### unlink
- **Signature**: `unlink(string $path): void`
- **Description**: Removes the file or link (suppressed error), no-op when absent.

#### rmDirAndContents
- **Signature**: `rmDirAndContents(string $path): void`
- **Description**: Recursive delete (CHILD_FIRST), then `rmdir($path)`.

#### chown
- **Signature**: `chown(string $path, string $user): void`
- **Description**: `chown($path, $user)`.

#### chgrp
- **Signature**: `chgrp(string $path, string $group): void`
- **Description**: `chgrp($path, $group)`.

#### realpath
- **Signature**: `realpath(string $path): string`
- **Description**: Resolve symlinks.

#### isLink
- **Signature**: `isLink(string $path): bool`
- **Description**: `is_link($path)`.

#### readLink
- **Signature**: `readLink(string $path): string`
- **Description**: `readlink($path)`.

#### removeBrokenLinksAt
- **Signature**: `removeBrokenLinksAt(string $path): void`
- **Description**: Unlink every broken link in the directory.

#### isBrokenLink
- **Signature**: `isBrokenLink(string $path): bool`
- **Description**: `is_link($path) && ! file_exists($path)`.

#### scandir
- **Signature**: `scandir(string $path): array`
- **Description**: Directory entries excluding `.`/`..`.

#### getStub
- **Signature**: `getStub(string $filename): string`
- **Description**: Reads `~/.config/valet/stubs/{filename}` if present, else the bundled `cli/stubs/{filename}` — enables user-overridable templates.

### Usage Example

```php
use Valet\Filesystem;

$files = resolve(Filesystem::class);

$files->ensureDirExists('/Users/me/.config/valet/Certificates', user());
$files->putAsUser('/Users/me/.config/valet/config.json', '{"tld":"test"}');
$files->symlinkAsUser('/Users/me/Code/app', '/Users/me/.config/valet/Sites/app');
$files->chown('/Users/me/.config/valet/config.json', 'me');
```

Custom stub override (advanced):

```php
// Place a file at ~/.config/valet/stubs/site.valet.conf to override the
// bundled Nginx site template for all newly generated configs
$contents = $files->getStub('site.valet.conf');
```
```

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

### Configuration::path

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Configuration.md

Returns the full path to the Valet configuration file.

```APIDOC
## Configuration::path

### Description
Returns the full path to the Valet configuration file.

### Method
path

### Return Value
string - The config file path.
```

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

### hasInstalledKeg(string $formula): bool

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Checks if a keg for the given formula is installed in the Cellar directory.

```APIDOC
## hasInstalledKeg(string $formula): bool

### Description
Returns true when `{BREW_PREFIX}/Cellar/{formulaName}` is a non-empty directory (keg installed from any tap).

### Method
hasInstalledKeg

### Parameters
- `$formula` (string) - Required - The name of the Homebrew formula to check.

### Return Value
- (bool) - True if a keg is installed, false otherwise.

```

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

### uninstallText method signature

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Valet.md

Returns manual uninstall instructions for 'valet uninstall' without --force.

```php
public function uninstallText(): string
```

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

### buildCertificateConf(string $path, string $url): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Site.md

Writes the openssl.conf stub with VALET_DOMAIN replaced by the URL.

```APIDOC
## buildCertificateConf(string $path, string $url): void

### Description
Writes the `openssl.conf` stub with `VALET_DOMAIN` replaced by `$url`.

### Method
buildCertificateConf

### Parameters
- `$path` (string) - Required - Path where the config will be written.
- `$url` (string) - Required - The domain to substitute.

### Returns
void
```

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

### Site::__construct

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Site.md

Constructor for the Site class. Injects dependencies for Brew, Configuration, CommandLine, and Filesystem.

```APIDOC
## Site::__construct

### Description
Constructor for the Site class. Injects dependencies for Brew, Configuration, CommandLine, and Filesystem.

### Method
__construct

### Signature
```php
public function __construct(public Brew $brew, public Configuration $config, public CommandLine $cli, public Filesystem $files) {}
```

### Parameters
- **$brew** (Valet\Brew) - Required - Homebrew helpers (PHP formulae, links).
- **$config** (Valet\Configuration) - Required - Config access (`tld`, `loopback`, `paths`).
- **$cli** (Valet\CommandLine) - Required - Runs `openssl`, `security`, `sudo ifconfig` etc.
- **$files** (Valet\Filesystem) - Required - File operations.

```

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

### createCa(int $caExpireInDays): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Site.md

Creates the Certificate Authority if absent and installs it in the System keychain. Throws DomainException on trust failure.

```APIDOC
## createCa(int $caExpireInDays): void

### Description
Creates `{CA}/LaravelValetCASelfSigned.{pem,key}` if absent (openssl `req -x509 -addext basicConstraints=critical,CA:TRUE …`) and installs it in the System keychain via `trustCa`. If both files already exist, verifies trust (`security verify-cert`) and re-trusts if needed. **`trustCa` throws `DomainException`** when `sudo security add-trusted-cert` exits non-zero.

### Method
createCa

### Parameters
- `$caExpireInDays` (int) - Required - Validity of the certificate authority in days.

### Returns
void

### Exceptions
- `DomainException` - If the CA cannot be trusted.
```

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

### private lint method

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Nginx.md

Runs 'sudo nginx -c {NGINX_CONF} -t' and throws DomainException on failure.

```php
private function lint(): void
```

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

### Error handling for corrupt brew services response

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Status.md

Example of catching an Exception from jsonFromCli when the brew services response is invalid JSON.

```php
try {
    $status = resolve(Status::class)->check();
} catch (Exception $e) {
    // "Invalid JSON returned from command: sudo brew services info --all --json"
}
```

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

### uninstall(): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/DnsMasq.md

Stops and uninstalls dnsmasq, removes the Valet-specific configuration file, and deletes the resolver file unless Laravel Herd is installed.

```APIDOC
## uninstall(): void

### Description
Stops and uninstalls dnsmasq, removes the Valet-specific configuration file, and deletes the resolver file unless Laravel Herd is installed.

### Method
uninstall

### Parameters
None

### Returns
void

### Example
```php
$dnsmasq->uninstall();
```
```

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

### Static method: show404()

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Server.md

Sets HTTP status 404, requires cli/templates/404.html, and exits. No return value.

```php
public static function show404()
```

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

### writer

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/overview.md

Get or set the global console writer singleton bound in the container as 'writer'. Returns the current writer or sets it if an OutputInterface is provided.

```APIDOC
## writer

### Description
Get/set the global console writer singleton bound in the container as `writer`.

### Signature
`function writer(?OutputInterface $writer = null): OutputInterface|\NullWriter|null`

### Parameters
- **$writer** (OutputInterface|null) - Optional - The writer instance to set.

### Returns
- **OutputInterface|\NullWriter|null** - The current writer instance.
```

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

### Resolving Valet services via container, facade, and helper

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/overview.md

Shows three equivalent ways to obtain a Valet service instance: the Site facade, the resolve() helper, and direct container access. Requires an Illuminate container instance to be set first.

```php
use Illuminate\Container\Container;
Container::setInstance(new Container);

Site::link('/Users/me/Code/my-app', 'my-app');      // via facade
$site = resolve(Valet\Site::class);                 // via helper
$site = Container::getInstance()->make(Valet\Site::class); // direct
```

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

### Constructor: __construct(array $config)

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Server.md

Initializes the Server instance with the decoded contents of ~/.config/valet/config.json. The $config property is deliberately not constructor-promoted to maintain PHP 7.4 compatibility.

```php
public $config;

public function __construct(array $config)
{
    $this->config = $config;
}
```

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

### trustCa method signature

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Site.md

Declares the public method that installs the CA certificate into the macOS System keychain. Throws DomainException when the sudo command fails.

```php
public function trustCa(string $caPemPath): void
```

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

### createCertificate(string $url, int $caExpireInDays): void

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Site.md

Builds the openssl config, private key, signing request, and signs with the CA. Falls back from runAsUser to run (sudo) on permission denied.

```APIDOC
## createCertificate(string $url, int $caExpireInDays): void

### Description
Builds the openssl config, private key (`genrsa 2048`), signing request, and signs with the CA (`openssl x509 -req -sha256 …`). Falls back from `runAsUser` to `run` (sudo) when the result contains `Permission denied`.

### Method
createCertificate

### Parameters
- `$url` (string) - Required - The domain to create a certificate for.
- `$caExpireInDays` (int) - Required - Validity of the certificate authority in days.

### Returns
void
```

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

### hasInstalledFormulaOrCask(string $formula): bool

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Brew.md

Parses `brew info {formula} --json=v2` to determine if a formula or cask is installed, handling errors for unavailable formulae.

```APIDOC
## hasInstalledFormulaOrCask(string $formula): bool

### Description
Parses `brew info {formula} --json=v2`; returns false for "Error: No available formula…"; checks `formulae[0].installed` or `casks[0].installed`.

### Method
hasInstalledFormulaOrCask

### Parameters
- `$formula` (string) - Required - The name of the Homebrew formula or cask to check.

### Return Value
- (bool) - True if the formula or cask is installed, false otherwise.

```

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

### Constructor: __construct(CommandLine $cli)

Source: https://github.com/laravel/valet/blob/main/_autodocs/api-reference/Composer.md

Initializes a new Composer instance with a CommandLine object used to run composer global commands as the user.

```APIDOC
## Constructor: __construct(CommandLine $cli)

### Description
Initializes a new Composer instance with a CommandLine object used to run composer global commands as the user.

### Method
Constructor

### Signature
```php
public function __construct(public CommandLine $cli) {}
```

### Parameters
- **$cli** (Valet\CommandLine) - Required - Runs `composer global …` as the user.

```
Tokens:
Raw