Download the PHP package ycodetech/valet-windows without Composer

This is a Windows port of the popular Mac development environment Laravel Valet.

Laravel Valet Windows 3 is a much needed updated fork of cretueusebiu/valet-windows, with lots of improvements and new commands. This version hopes to achieve as much parity as possible with the Mac version. For command parity, please refer to the parity checker.

[!WARNING]

If you're coming from cretueusebiu/valet-windows, then you need to make sure to fully uninstall it from your computer, deleting all configs, and removing from composer with composer global remove cretueusebiu/valet-windows, before installing this 3.0 version.

Contributions

---

Commands Section	Installing/Uninstalling & Starting/Stopping	PHP Services	Multi-PHP Versions and Securing	Parked, Linked, Proxies and Sites	Sharing	Other Commands
Command	install	php:add	use	park	share	tld
	sudo	php:remove	isolate	parked	auth|set-ngrok-token	which
	start	php:install	isolated	unpark|forget	url|fetch-share-url	paths
	restart	php:uninstall	unisolate	link	ngrok	open
	stop	php:list	secure	links		latest|on-latest-version
	uninstall	php:which	secured	unlink		log
		php|php:proxy	unsecure	proxy		services
		xdebug:install		proxies		directory-listing
		xdebug:uninstall		unproxy		diagnose
				sites		parity
						nginx-error-page

Introduction

Valet is a Laravel development environment for Windows. No Vagrant, no /etc/hosts file. You can even share your sites publicly using local tunnels. Yeah, we like it too.

Laravel Valet configures your Windows to always run Nginx in the background when your machine starts. Then, using Acrylic DNS, Valet proxies all requests on the *.test domain (aka tld) to point to sites installed on your local machine.

This is 3.0 of Valet Windows, branded under the name Laravel Valet Windows 3, and is a much needed updated fork of cretueusebiu/valet-windows. It introduces lots of improvements, new commands, and hopes to achieve as much parity as possible with the original Mac version.

Services shipped with Valet

Valet ships with and installs these services:

Service	Version
ngrok	3.3.1

[!IMPORTANT] ngrok may error out that it is "too old" when running it for some accounts. In the upcoming v3.2.0 release, Valet will ship with the latest version of ngrok.

In the meantime, you can update the ngrok executable manually by running valet ngrok update. This will directly update the executable to the latest version.

Afterwards, you will need to run valet ngrok config upgrade to upgrade the config file to the latest format.

For both commands, valet automatically appends the config file location as a flag to the command, so ngrok will already know where the config file is.

As of v3.2.0 and v3.3.0, Valet no longer ships with the executables for the following services, instead they will be downloaded and installed automatically from it's online source (GitHub, SourceForge, etc.). This is so that the latest versions with bug fixes and security updates can be installed.

Service	Latest Version as of 2025-10-22
Ansicon	1.89
gsudo	2.6.1
nginx	1.29.2
WinSW	2.12.0
Acrylic DNS Proxy	2.2.1

[!IMPORTANT]

nginx has changed some of the config options in v1.25.1, due to this, valet will run a site config check to detect if any of the site.conf needs upgrading. Valet will then automatically remove any of the old conf files and re-isolate/re-secure the sites with the updated configurations.

Theses upgrades are only for http2 and http2_push_preload options. Any future changes from nginx will be need to be upgraded in Valet internally as and when they arise, please submit an issue.

Installation

Before installation, make sure that no other programs such as Apache or Nginx are binding to your local machine's port 80. If XAMPP or similar is installed make sure they don't have Windows services installed and change their ports.

Also make sure to open your preferred terminal (Windows Terminal, CMD, Git Bash, PowerShell, etc.) as Administrator. You can use VS Code integrated terminal, but if VS Code isn't opened as Administrator, then a bunch of User Account Control (UAC) pop ups will appear in order to give access to Valet. You can also use a non Administrator terminal without the popups, you'll just need to use Valet's sudo command before any other Valet commands.

[!NOTE]

Laravel Valet Windows 3 is developed and tested to run on Windows 10. In theory it should run on Windows 11 and up, but there's no guarantee. Testers and contributors are always welcome though.

---

• If you don't have PHP installed, make sure to install it.

  Download the Zip file and unzip into a directory of your choosing. The recommended directory is: C:/php/.

  You may use Thread Safe (TS), but Non-Thread Safe (NTS) is better for using PHP on the FastCGI protocol, which Valet uses.

  For NTS binaries the widespread use case is interaction with a web server through the FastCGI protocol, utilizing no multithreading (but also for example CLI).

• If you don't have Composer installed, make sure to install it.

• Install Valet with Composer via composer global require ycodetech/valet-windows.

  [!WARNING]

  If you're coming from cretueusebiu/valet-windows, then you need to make sure to fully uninstall it from your computer, deleting all configs, and removing from composer with composer global remove cretueusebiu/valet-windows, before installing this 3.0 version.

• Install Valet by running the valet install command, or alternatively valet sudo install with administrator elevation. This will configure and install Valet and register Valet's daemon to launch when your system starts. Once installed, Valet will automatically start it's services.

• If you're installing on Windows 10/11, you may need to manually configure Windows to use the Acrylic DNS Proxy.

Valet will automatically start its daemon each time your machine boots. There is no need to run valet start or valet install ever again once the initial Valet installation is complete.

Commands

For commands that are referenced as "the same as the Mac version", please refer to the official documentation on the Laravel website for more information.

Installing/Uninstalling & Starting/Stopping

install

This installs all Valet services:

• Nginx
• PHP CGI
• PHP Xdebug CGI [optional]
• Acrylic DNS
• Ansicon

And it's configs in C:/Users/Username/.config/valet.

Once complete, Valet will automatically start the services.

[!NOTE]

If install is ran again when it's already installed, Valet will ask if you want to proceed to reinstall.

install --xdebug

--xdebug is a boolean option to optionally install Xdebug for PHP. If the option is present, it's true, otherwise false.

sudo

sudo is a Windows equivalent of the Mac command utilty of the same name, provided by gsudo. The command allows you to pass through Valet commands to gsudo, gsudo will then elevate the command to use the highest system administrator privileges, without the need for multiple User Account Control (UAC) popups...

gsudo only requires 1 UAC popup to enable elevation (per usage), and then the passed Valet command, it's arguments, values and options will be executed as the system with no further UACs.

valetCommand

valetCommand is the Valet command, plus it's argument's values that you wish to run. It is a string array separated by spaces.

In the example above, isolate is the command name and 7.4 is the argument value.

When specifying the Valet command, you can pass the valet CLI keyword before the command as you would normally, but this is optional. If it's omitted, Valet will add it automatically. It's preferred to omit the keyword as it's cleaner.

--valetOptions

--valetOptions (shortcut -o) [optional] is the Valet options/flags for a Valet command. It is a string, but multiple options can be specified. Please see the important notes about this option.

start

This command is the same as the Mac version.

restart

This command is the same as the Mac version.

stop

This command is the same as the Mac version.

uninstall

This completely stops and uninstalls all of Valet's services.

You will also need to uninstall Valet if you are wanting to update Valet via Composer (composer global update ycodetech/valet-windows), just to make sure Composer can remove and update relevant files without error.

[!CAUTION]

If composer global update is ran before valet is uninstalled, then several running services may prevent composer from removing the files and updating valet.

If this happens you can use the emergency_uninstall_services.bat file to stop and uninstall the services. See Emergency Stop and Uninstall Services section.

--force

--force is to optionally force an uninstallation without Valet asking confirmation.

--purge-config

--purge-config (shortcut -p) is to optionally purge and remove all Valet's configs. This should be used if Valet is no longer required and it won't be installed again.

PHP Services

php:add

[!NOTE]

When adding PHP, the full version number (eg. 7.4.33) will be extracted and an alias (eg. 7.4) will be generated. Either of these can be used in other commands.

Furthermore, the details of the versions will be written to the config in a natural decending order that adheres to decimals. This means that when two minor versions (like 8.1.8 and 8.1.18) of an alias (8.1) are added, and the default PHP is then set to use the alias, then Valet will use the most recent version of the alias, which in this case would be 8.1.18.

[!TIP]

You may specify the path without quotes, but if the directory has spaces in like C:/Program Files/php/7.4 then it must be surrounded in quotes. Otherwise valet will encounter an error.

php:add --xdebug

--xdebug is a boolean option to optionally install Xdebug for the PHP being added. If the option is present, it's true, otherwise false.

php:remove

Both the full version and the alias version works:

--path

Instead of using the version number, you can specify the PHP by it's path.

[!NOTE]

If Xdebug is installed for the PHP being removed, then Valet will also remove Xdebug for that version too.

php:install

php:install Installs the PHP CGI services for the versions listed in Valet with php:list. If they are already installed, Valet uninstalls them first and then reinstalls them.

php:uninstall

php:uninstall Uninstalls the PHP CGI services for the versions listed in Valet with php:list.

php:list

List the PHP versions installed in Valet.

php:which

This command is the same as the Mac version, just renamed.

php:proxy

php is a command alias.

This command is the same as the Mac version.

xdebug:install

xdebug:install installs an Xdebug service for all PHP versions listed in Valet with php:list.

Valet only installs an Xdebug PHP CGI service on a separate port to work along side the PHP CGI service, it doesn't install Xdebug itself. Please read the Xdebug Installation for further information.

You can optionally install Xdebug for one specific PHP version using the phpVersion argument.

[!NOTE]

If Xdebug for the supplied PHP version is already installed, Valet will ask if you want it reinstalling.

xdebug:uninstall

You can optionally uninstall Xdebug for one specific PHP version using the phpVersion argument.

Using PHP versions

use

[!NOTE]

If using the alias, and multiple versions of 8.1 are available eg. 8.1.8 and 8.1.18, then the most latest version will be used eg. 8.1.18.

isolate

[!TIP]

You can isolate 1 or more sites at a time. Just pass the --site option for each of the sites you wish to isolate to the same PHP version.

This command is the same as the Mac version.

isolated

This command is the same as the Mac version.

unisolate

unisolate --all

--all is a boolean option to optionally unisolate all the currently isolated sites. If the option is present, it's true, otherwise false.

secure

Secures a site with a trusted self-signed TLS certificate and serves the site on the https protocol.

[!TIP]

The secure command (or secure option in any other commands) need to be used in an admin privileged/elevated terminal. Either open a terminal as administrator or use the sudo command.

secured

This command is the same as the Mac version.

unsecure

Unsecures a site by removing it's TLS certificate and serves the site on the http protocol.

unsecure --all

--all is a boolean option to optionally unsecure all the currently secured sites. If the option is present, it's true, otherwise false.

This command is the same as the Mac version.

Parked, Linked, Proxies and Sites

park

park registers a directory that contains all your sites to Valet. Once the directory has been parked, Valet will automatically serve all sub-directories as sites, accessible in the web browser. They serve in the form of http://<directory-name>.test

To view all registered directories, use the paths command.

Laravel Valet docs.

parked

[!NOTE]

If there's a parked site that is also a symbolic linked site, then it will also output the linked site name (aka alias) and it's URL (aka alias URL).

unpark|forget

To stop auto-serving sub-directories as sites, run the forget command to forget the directory.

unpark is a command alias.

This command is the same as the Mac version.

link

link is another way to serve directories as sites, except it serves one singular site in a directory rather than the whole directory. It does this by creating a symbolic link inside the ~/.config/valet/Sites directory, of which is a parked directory on Valet installation.

Serving the current working directory as a site:

name

If you wish to serve the site under a different name to that of the directory, just pass the optional name argument. This is most useful if the directory has spaces in the name, Valet doesn't URL encode spaces or any other non-URL safe characters, so the site won't work without changing it.

--secure

--secure option allows you to secure the site. It is boolean, so if it's present it's true, otherwise false.

--isolate

--isolate option allows you to isolate the site to a specific PHP version. Pass it with a value.

Laravel Valet docs.

links

This command is the same as the Mac version.

unlink

unlink removes the current working directory's (cwd) symbolic linked site. Valet will find the linked site name using the cwd name and delete the symbolic link from the ~/.config/valet/Sites/ directory.

name

name specifies the name of the symbolic link.

[!NOTE]

If the linked site is secured, Valet will unsecure it before removing.

[!NOTE]

If the linked site is isolated, Valet will unisolate it before removing.

This command is the same as the Mac version.

proxy

proxy allows you to proxy a Valet site to another service on your machine and send all traffic from the Valet site to the service. You may also proxy multiple sites to 1 host by separating them with commas.

proxy --secure

--secure option allows you to secure the proxy site. It is boolean, so if it's present it's true, otherwise false.

This command is the same as the Mac version.

proxies

This command is the same as the Mac version.

unproxy

Just like the proxy command, you may unproxy multiple sites at once by separating them with commas.

This command is the same as the Mac version.

sites

Sharing

[!NOTE]

ngrok ships with Valet internally, there is no need to download it separately.

share

Share your local site publically. ngrok will do all the magic for you and give you a publically accessible URL to share to clients or team members.

Before sharing a site with ngrok, you must first set the authtoken using Valet's set-ngrok-token command.

[!NOTE]

Prior to v3.4.4, the public URL wasn't displayed and the fetch-share-url command had to be used instead to get the URL and copy it to the clipboard.

As of v3.4.4, the public URL will be displayed and automatically copied to your clipboard (requires ngrok's real-time logging). You can still use the fetch-share-url command in a separate terminal though.

[!IMPORTANT]

ngrok will now output logging information directly to the terminal in real-time by default using the --log=stdout option. Valet redirects stderr to stdout, so all logging information will be outputted to the terminal. This is useful for debugging and seeing what ngrok is doing in real-time. For this reason the --log=stderr is exactly the same output as --log=stdout.

If you wish to disable real-time logging, you can use the valet's --options argument to pass ngrok's log=false option; this will disable all logging output to the terminal, including the public URL.

share --options

--options (shortcut -o) [optional] is ngrok's options/flags for it's http command (which valet share uses internally). It is a string, but multiple options can be specified. Please see the important notes about this option.

auth|set-ngrok-token

auth is a command alias.

Before sharing a site with ngrok, you must first set the authtoken, which can be accessed in your ngrok account.

This command is the same as the Mac version.

url|fetch-share-url

url is a command alias.

Once sharing a site with valet share, you can get the public URL using this command in a separate terminal. The URL will be outputted to the terminal and will also be copied to the clipboard for ease of use.

This command is the same as the Mac version.

ngrok

Because ngrok CLI has a multitude of commands and options, the valet ngrok command is very useful for passing through any and all commands to ngrok.

ngrok commands

The commands argument is a space-separated array of the commands plus it's argument's values.

ngrok --options

The --options (shortcut -o) [optional] can be used to pass options/flags to ngrok. It is a string, but multiple options can be specified. Please see the important notes about this option.

Other commands

tld

tld gets the current Top Level Domain (TLD) that Valet is using.

When developing, you may like to use a different TLD. Valet serves sites on the default .test TLD, but you can also set a different one with this command, just pass the new TLD as it's argument.

[!CAUTION]

When choosing a TLD, you need to be careful not to use one that could potentially be used on the Web. If your site name and TLD match a real web address, then the browser will resolve the request and redirect it to the real website instead of Valet resolving it to your local project.

Example: Your local Roots Bedrock site on bedrock.dev will redirect to the Minecraft Bedrock website.

Generally, the special-use domains listed on Wikipedia, and any unique custom ones like .code, are all good to use as they are invalid TLDs.

This command is the same as the Mac version. Note: the Mac version has officially discontinued it's use; whereas Valet Windows 3 won't.

which

This command is the same as the Mac version.

paths

paths allows you to view all registered paths. The default path is ~/.config/valet/Sites, any others are added via the park command.

This command is the same as the Mac version.

open

open          Open the current working directory site in the browser
      [site]  Optionally, specify a site

$ cd /d/sites/site1
$ valet open

$ valet open site1

This command is the same as the Mac version.

latest|on-latest-version

latest | on-latest-version  Determine if this is the latest version/release of Valet

latest is a command alias.

$ valet on-latest-version
$ valet latest
Yes

on-latest-version determines whether the installed version of Valet is the latest. If not, then Valet will prompt you to update.

This command is the same as the Mac version.

log

log                 View and follow a log file
     [key]          The name of the log
     [-l|--lines]   The number of lines to view
     [-f|--follow]  Follow real time streaming output of the changing file

$ valet log nginx --lines=3 --follow
$ valet log nginx -l 3 -f

log allows you to view the logs which are written by Valet's services. To view a list of logs, simply run valet log.

$ valet log
┌───────────────────────┬───────────────────────────────────────────────────────────────┐
│ Key                   │ File                                                          │
├───────────────────────┼───────────────────────────────────────────────────────────────┤
│ nginx                 │ C:/Users/Username/.config/valet/Log/nginx-error.log           │
├───────────────────────┼───────────────────────────────────────────────────────────────┤
│ nginxservice.err      │ C:/Users/Username/.config/valet/Log/nginxservice.err.log      │
├───────────────────────┼───────────────────────────────────────────────────────────────┤
│ nginxservice.out      │ C:/Users/Username/.config/valet/Log/nginxservice.out.log      │
├───────────────────────┼───────────────────────────────────────────────────────────────┤
│ nginxservice.wrapper  │ C:/Users/Username/.config/valet/Log/nginxservice.wrapper.log  │
├───────────────────────┼───────────────────────────────────────────────────────────────┤
│ phpcgiservice.err     │ C:/Users/Username/.config/valet/Log/phpcgiservice.err.log     │
├───────────────────────┼───────────────────────────────────────────────────────────────┤
│ phpcgiservice.out     │ C:/Users/Username/.config/valet/Log/phpcgiservice.out.log     │
├───────────────────────┼───────────────────────────────────────────────────────────────┤
│ phpcgiservice.wrapper │ C:/Users/Username/.config/valet/Log/phpcgiservice.wrapper.log │
└───────────────────────┴───────────────────────────────────────────────────────────────┘

The key is required in order to view a log. It can be found from the list of logs.

--lines

The --lines (shortcut -l) option changes the number of lines to view from the log.

$ valet log nginx --lines=3
$ valet log nginx -l 3

--follow

The --follow (shortcut -f) option can be used to follow real time streaming output of the changing file.

$ valet log nginx --follow
$ valet log nginx -f

[!TIP]

--follow is set to stream output "forever" (though one can never be too sure if it actually is forever). To stop the output stream, you need to press ctrl+C.

This command is the same as the Mac version.

services

services  List the installed Valet services

$ valet services
Checking the Valet services...
┌───────────────────┬────────────────────────────────┬───────────────┐
| Service           | Windows Name                   | Status        |
├───────────────────┼────────────────────────────────┼───────────────┤
| acrylic           | AcrylicDNSProxySvc             | running       |
├───────────────────┼────────────────────────────────┼───────────────┤
| nginx             | valet_nginx                    | running       |
├───────────────────┼────────────────────────────────┼───────────────┤
| php 8.1.8         | valet_php8.1.8cgi-9001         | running       |
├───────────────────┼────────────────────────────────┼───────────────┤
| php 7.4.33        | valet_php7.4.33cgi-9002        | running       |
├───────────────────┼────────────────────────────────┼───────────────┤
| php-xdebug 8.1.8  | valet_php8.1.8cgi_xdebug-9101  | not installed |
├───────────────────┼────────────────────────────────┼───────────────┤
| php-xdebug 7.4.33 | valet_php7.4.33cgi_xdebug-9102 | running       |
└───────────────────┴────────────────────────────────┴───────────────┘

directory-listing

directory-listing            Determine directory-listing behaviour. Default is off, which means a 404 will display
                   [status]  Optionally, switch directory listing [on, off]

$ valet directory-listing
Directory listing is off

$ valet directory-listing on
Directory listing setting is now: on

This command is the same as the Mac version.

diagnose

diagnose                Output diagnostics to aid in debugging Valet.
          [-p|--print]  Optionally print diagnostics output while running
          [--plain]     Optionally print and format output as plain text (aka, pretty print)

$ valet diagnose
Running diagnostics...
[Diagnostics output here]

The diagnostics will be copied to the clipboard as formatted HTML for easy issue reporting.

This command is the same as the Mac version.

parity

parity  Output the calculation of the percentage of parity completion against Laravel Valet (macOS) of a specific version.

$ valet parity
Out of a total 39 commands, 36 are possible for parity, with 34 complete, and 11 brand new commands.
Parity at 87% out of a total 92% possible parity with the Laravel Valet (macOS) v4.3.0

This command is a way to determine how much parity has been achieved.

nginx-error-page

nginx-error-page               Display the current visibility of the nginx error page.
                 [visibility]  Optionally, set to "on" to enable Valet's nginx error page, or "off" to disable it.

$ valet nginx-error-page
Valet's nginx error pages are on.

$ valet nginx-error-page off
Valet's nginx error pages are now off.

The nginx error pages are on (enabled) by default, which means that Valet's custom nginx 404/500 error pages will be shown when an error is encountered. However, for those who prefer to use a framework's error reporting exception pages like that of Symfony or Laravel, Valet's nginx error pages can be turned off (disabled).

---

Notes for all --options

These are important notes for the commands that have the --options or --valetOptions.

• The --options, --valetOptions (shortcut -o) options can be used to pass options/flags to the service related to that command.

  Just pass the option name without the -- prefix eg. --options=config=C:/path/ngrok.yml (example for the ngrok command). This is so that Valet doesn't get confused with it's own options.

  All options/flags that are passed will be prefixed with -- after Valet has processed the command, unless it's a shortcut of a single character, then it will be prefixed with -. The example above will run as --config=C:/path/ngrok.yml.

• The = immediately after the command option is optional, if it's omitted, you must use a space instead.

  --options=option1
  --options option1
  --valetOptions=option1
  --valetOptions option1

• The options also have -o shortcuts and it cannot have the = character, it must use a space for separation.

  -o option1

  This falls inline with Symfony's docs and complies with command-line standards.

  From Symfony's docs:

  Note that to comply with the docopt standard, long options can specify their values after a whitespace or an = sign (e.g. --iterations 5 or --iterations=5), but short options can only use whitespaces or no separation at all (e.g. -i 5 or -i5).

• The options also allows multiple options to be passed, they just need to be separated with double slashes //.

  --valetOptions=option1//option2//option3
  --options option1//option2//option3
  -o option1//option2//option3

Command Parity Checker

Commands that have been tested and made parity:

• [ ] composer - not applicable
• [x] diagnose
• [x] directory-listing
• [x] fetch-share-url
• [x] forget
• [x] install
• [x] isolate
• [x] isolated
• [x] link
• [x] links
• [x] log
• [ ] loopback (the localhost IP) - not applicable
• [x] on-latest-version
• [x] open
• [x] park
• [x] parked
• [x] paths
• [x] php (proxying commands to PHP CLI) - renamed to php:proxy with alias of php
• [x] proxies
• [x] proxy
• [ ] renew (Renews all domains with a trusted TLS certificate) - TBD
• [x] restart
• [x] secure
• [x] secured
• [x] set-ngrok-token
• [x] share
• [x] share-tool
• [x] start
• [x] status - renamed to services
• [x] stop
• [x] tld
• [ ] trust - not applicable
• [x] uninstall
• [x] unisolate
• [x] unlink
• [x] unproxy
• [x] unsecure
• [x] use
• [x] which
• [x] which-php - renamed to php:which

To see a calculation of how much parity has been achieved, see the parity command.

Deprecations and Removals

Deprecated	Since Version	Will be Removed in Version	Removed?
The `install` command confirmation question about uninstalling the outdated cretueusebiu package. Doesn't affect valet functionality.	3.1.0	3.2.0	✓

## Emergency Stop and Uninstall Services As of v3.1.6, Valet has an emergency stop and uninstall services script. This script is copied to the `/.config/valet/Emergency Uninstall` directory for safe keeping. So if `composer global update` is ran before valet is uninstalled, and several running services prevent composer from removing the files and updating valet, then you can run the `emergency_uninstall_services.bat` file to stop and uninstall the services. To run, open a CMD terminal with Admin privileges and run this: ```sh > "%UserProfile%\.config\valet\Emergency Uninstall\emergency_uninstall_services.bat" ``` Alternatively, find it in the File Explorer and double clicking the file will also run it. All services will have been stopped and removed and you can then be able to run `composer global update`. > [!IMPORTANT] > > If you receive the `The system cannot find the path specified` error or similar while installing valet, then usually it's to do with Ansicon leaving it's path in the registry after uninstalling, which then fails Valet's installation. > > The emergency uninstall script can help to uninstall Ansicon again and hopefully fully removing it from the registry. ## Valet Directories Upon installation, Valet creates the following directories and config files: - `~/.config/valet` Contains all of Valet's config files. This resides in the home directory (`C:/Users/Username/`) indicated by `~`. - `~/.config/valet/CA` Contains Valet's generated self-signed Root CA certificate, of which all site TLS certificates are signed with. - `~/.config/valet/Certificates` Contains all the TLS certificates for the secured sites. These files are rebuilt when running the `install` and `secure` commands. - `~/.config/valet/Drivers` Contains any user-defined custom Valet drivers. Drivers determine how a particular framework / CMS is served. See the [Valet Docs](https://laravel.com/docs/12.x/valet#custom-valet-drivers) for information on how to create a custom driver. - `~/.config/valet/Drivers/SampleValetDriver.php` A sample custom driver. - `~/.config/valet/Extensions` Contains custom Valet extensions/commands. You can extend Valet and add your own commands or change existing ones. See [this comment](https://github.com/laravel/valet/issues/804#issuecomment-569731561) for more info and links to examples. - `~/.config/valet/Log` Contains all error logs. - `~/.config/valet/Nginx` Contains site-specific Nginx configs for any site that is isolated or secured. These files are rebuilt when running the `install`, `tld`, and `secure` commands. - `~/.config/valet/Ngrok` Contains the `ngrok.yml` config file for the ngrok executable to be able to `share` sites. This directory and file will only be created when the `set-ngrok-token` command is run. - `~/.config/valet/Services` Contains the Nginx and PHP config and executable files to be able to run them as Windows services. These files are rebuilt when running the `install` command. - `~/.config/valet/Sites` Contains all of the symbolic links for any `link`ed sites. - `~/.config/valet/stubs` A user-created directory to contain custom stubs. Only used in Valet if it exists, and overrides Valet's internal stubs. - `~/.config/valet/Xdebug` Contains the output files of Xdebug profiling. - `~/.config/valet/config.json` This is the main Valet config file. - `~/.config/valet/Emergency Uninstall` Contains the emergency uninstall files. - `~/.config/valet/Emergency Uninstall/ansicon` Contains the Ansicon files and executable to help uninstall it. - `~/.config/valet/Emergency Uninstall/emergency_uninstall_services.bat` This is an batch file to do an emergency stop and uninstall of all services. See the [Emergency Stop and Uninstall Services section](#emergency-stop-and-uninstall-services). > [!WARNING] > > It's not recommended to change the config files except the custom `Drivers` and `Extensions`. Changing any other config file manually will put Valet out of sync and cause errors. Use the CLI instead and let Valet do it for you. > [!CAUTION] > > You must not remove any config file (except the custom ones) without first uninstalling Valet. ## Known Issues - WSL2 distros fail because of Acrylic DNS Proxy ([microsoft/wsl#4929](https://github.com/microsoft/WSL/issues/4929)). Use `valet stop`, start WSL2 then `valet start`. - The PHP-CGI process uses port 9001. If it's already used change it in `~/.config/valet/config.json` and run `valet install` again. - ~~When sharing sites the url will not be copied to the clipboard.~~ The URL will now be copied to the clipboard automatically as of v3.4.4; see the [share command](#share) for more information. - ~~You must run the `valet` commands from the drive where Valet is installed, except for park and link. See [#12](https://github.com/cretueusebiu/valet-windows/issues/12#issuecomment-283111834).~~ All commands seem to work fine on all drives. - If your machine is not connected to the internet you'll have to manually add the domains in your `hosts` file or you can install the [Microsoft Loopback Adapter](https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/install-microsoft-loopback-adapter) as this simulates an active local network interface that Valet can bind too. - When trying to run Valet on PHP 7.4 and you get this error: > Composer detected issues in your platform: > > Your Composer dependencies require a PHP version ">= 8.1.0". You are running 7.4.33. > > PHP Fatal error: Composer detected issues in your platform: Your Composer dependencies require a PHP version ">= 8.1.0". You are running 7.4.33. in C:\Users\Username\AppData\Roaming\Composer\vendor\composer\platform_check.php on line 24 It means that a dependency of Valet's dependencies requires 8.1. You can rectify this error by running `composer global update` while on 7.4, and composer will downgrade any global dependencies to versions that will work on 7.4. See this [Stack Overflow answer](https://stackoverflow.com/a/75080139/2358222). > [!NOTE] > > This will of course downgrade all global packages. Depending on the packages, it may break some things. If you just want to downgrade valet dependencies, then you can specify the Valet namespace. `composer global update ycodetech/valet-windows`. > [!WARNING] > > It's recommended to use PHP 8.1 anyway, downgrading will mean some things may break or cause visual glitches in the terminal output. So downgrade at your own risk. > [!NOTE] > > Make sure you uninstall Valet before `composer global update`, to make sure all services have been stopped and uninstalled before composer removes and updates them. Otherwise errors occur and composer can't update in-use files. If this does happen please refer to the [Emergency Stop and Uninstall Services](#emergency-stop-and-uninstall-services) section. - If you're using a framework that uses a .env file and sets the domain name, such as `WP_HOME` for Laravel Bedrock, then make sure the TLD is the same as the one set for Valet. Otherwise, when trying to reach a site, the site will auto redirect to use the TLD in set in the .env. Example: `WP_HOME='http://mySite.test'`, Valet gets a request to `http://mySite.dev`, the site will auto redirect to `http://mySite.test`. If this still happens after changing the TLD, then it has been cached by the browser, despite NGINX specifying headers not to cache. To rectify try `"Empty cache and hard reload"` option of the page reload button. - On rare occasions, you may encounter a WMI error: > FATAL - WMI Operation failure: InvalidServiceControl >
WMI.WmiException: InvalidServiceControl >
     at WMI.WmiRoot.BaseHandler.CheckError(ManagementBaseObject result) >
     at WMI.WmiRoot.InstanceHandler.Invoke(Object proxy, MethodInfo method, Object[] arguments) >
     at WinSW.Program.<Run>g**Stop|2_3(<>c**DisplayClass2_0& ) >
     at WinSW.Program.Run(String[] argsArray, IWinSWConfiguration descriptor) >
     at WinSW.Program.Main(String[] args) While using `valet use`, the error may have been caused by Valet trying to stop the nginx service twice, of which [this commit](https://github.com/yCodeTech/valet-windows/commit/afcafffbc9e58c00ee54b59c6929f62f2cffa8a3) tries to fix. Though it's difficult to debug an error that only occurs 1% of the time, with it being useless in terms of information when it does. If the WMI error does occur, try running the command again. If different WMI errors occur, please submit an issue with all relevant details. - If there is a large error and it's file trace output to the terminal, the top of the error may be cut off/overwritten. Apparently Symfony can only write to the terminal that is viewable, if it goes outside of the viewable area (ie. you need to scroll up to view) then the output is overwritten and the most important part of the error, the description at the start is cut off. (See https://github.com/symfony/symfony/issues/35012). If this happens, make the terminal larger in height and try the command again to try and view the full error. - When trying to install Valet after updating via Composer, and you receive this error or similiar: `The system cannot find the path specified`; it could be that Ansicon hasn't uninstalled properly and left it's path in the registry. Because it happens unpredictably, there is no way of debugging or fixing it. The only "workaround" is to use the emergency uninstall script (`emergency_uninstall_services.bat`) in the `~/.config/valet/Emergency Uninstall` directory to allow Ansicon another chance to uninstall itself properly. (See [issue 28](https://github.com/yCodeTech/valet-windows/issues/28)). See the [Emergency Stop and Uninstall Services section](#emergency-stop-and-uninstall-services). ## Xdebug Installation Valet only installs a specific Xdebug PHP CGI service on a separate port to work alongside the PHP service. To install Xdebug itself, follow the [official guide](https://xdebug.org/docs/install). When configuring Xdebug, make sure to set the Xdebug port to the same port that Valet has setup for the Xdebug CGI service. You can find this written in the Valet config, or use the [php:list](#phplist) command. To enable a debugging session you can use [Xdebug helper](https://chrome.google.com/webstore/detail/xdebug-helper/eadndfjplgieldjbigjakmdgkmoaaaoc), or set a cookie with the name `XDEBUG_SESSION`, or a VScode extension. ###### Dev comment: I'm not entirely sure how Xdebug works. So please refer to online guides for further guidance. ## Contributions Taylor Otwell, et al - [Laravel Valet](https://github.com/laravel/valet) Cretueusebiu - [Valet Windows port](https://github.com/cretueusebiu/valet-windows) Iamroi - [Valet Windows: Feature PR for multiple PHP support](https://github.com/cretueusebiu/valet-windows/pull/195) Damsfx - [Valet Windows: Patch 1 PR on Iamroi's repo to add PHP versions to `links` command](https://github.com/iamroi/valet-windows/pull/1) yCodeTech - [Laravel Valet Windows 3](https://github.com/yCodeTech/valet-windows) Hemant-kr-meena - [various PRs](https://github.com/yCodeTech/valet-windows/pulls?q=is%3Apr+author%3Ahemant-kr-meena) Onecentlin - [Update Laravel Installer requirements PR](https://github.com/yCodeTech/valet-windows/pull/10) Jerrens - [Changed AcrylicDNS binding address PR](https://github.com/yCodeTech/valet-windows/pull/15) ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. ## License Laravel Valet is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).

---

All versions of valet-windows with dependencies

Composer command for our command line client (download client)This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free.Standard composer command

The package ycodetech/valet-windows contains the following files