Referencia completa de la CLI
Todos los comandos, argumentos y opciones de yard.
Guía técnica disponible en inglés. Esta referencia conserva los nombres de comandos y el contenido técnico original en inglés.
The CLI shares app operations. Keep Yard open for commands that need its services. This reference is generated from executable help without starting services or modifying projects.
All commands
OVERVIEW: Yard – a native PHP and Laravel development environment for macOS.
Run `yard help COMMAND` to see all arguments and options of a command. Many
commands support --json.
USAGE: yard <subcommand>
OPTIONS:
--version Show the version.
-h, --help Show help information.
SUBCOMMANDS:
list List all commands
SITE MANAGEMENT SUBCOMMANDS:
park Register the current working (or specified) directory
with Yard
parked Display all the current sites within parked paths
forget Remove the current working (or specified) directory
from Yard's list of paths
link Link the current working directory to Yard
links Display all of the registered Yard links
unlink Remove the specified Yard link
sites List all sites that Yard is currently serving
paths Get all of the paths registered with Yard
open Open the site for the current (or specified)
directory in your browser
edit Open the current directory in your configured IDE
site:info Show everything about a site: URL, PHP and Node.js
versions, services, capabilities and workspaces
site:env Read and edit the .env file of a site (keeps comments
and order)
site:services Show or change the database, queue, cache and
broadcasting service of a site
site-information Display information about the specified site as JSON
(Laravel: php artisan about)
which Display which Yard driver serves the current working
directory
site:doctor Check a project's environment without changing it
site:report Export a consistent, redacted project test report
YARD STUDIO SUBCOMMANDS:
studio Open Yard Studio for the current or given site in
your browser
ai:models List the safe model catalogue discovered from
OpenCode.
PROJECT ENVIRONMENTS SUBCOMMANDS:
project:start Start this project's configured frontend and Laravel
workers
project:stop Stop this project's processes while keeping shared
services running
project:processes Show this project's supervised processes
project:configure Choose which processes start with a project
project:isolate Separate this Laravel project's database, cache,
queue and sessions (SQL databases start empty)
project:unisolate Restore the previous project connection while
retaining isolated data
audit Audit a project's locked Composer and JavaScript
dependencies
db:snapshot Create a named database restore point
db:snapshots List database restore points for a project
db:restore Restore a project's database, first saving its
current state
LARAVEL SAIL SUBCOMMANDS:
sail:enable Serve a Laravel Sail project from its Docker
containers (assigns free ports, updates .env, starts
Sail)
sail:disable Stop serving a site from Sail: stops the containers
and restores the .env values Yard changed
sail:status Show the Laravel Sail state of a site
sail:start Start the Sail containers of a site
sail:stop Stop the Sail containers of a site
WORKSPACES SUBCOMMANDS:
workspace Create a new workspace for the current site (inside a
git worktree: register it)
workspaces List all workspaces with parent site, URL, PHP
version, database and type
workspace:switch Open a new shell inside a workspace (type `exit` to
return)
workspace:open Open a workspace in your browser
workspace:merge Merge the branch of a workspace into the branch it
was created from
workspace:delete Delete a workspace including its site, certificate
and isolated database (the branch stays)
DATABASES SUBCOMMANDS:
db Open the database of the current or given site in
your database client
db:connection Show the database connection of a site and a
connection URL
db:list List all databases on the server that the site uses
db:use Point the site at another database on the same server
db:create Create a database on the server that the site uses
db:drop Drop a database on the server that the site uses
PHP VERSION MANAGEMENT SUBCOMMANDS:
use Change the global PHP version used to serve sites
without an isolated version
isolate Use a specific PHP version for the current site (or
--site)
unisolate Revert a site back to Yard's global PHP version
isolated List all sites using isolated PHP versions
php Proxy PHP commands with the isolated site's PHP
executable
composer Proxy Composer commands with the isolated site's PHP
executable
which-php Display which PHP binary Yard uses for the current
directory
ini Open the php.ini for the current (or given) PHP
version in your IDE
php:list List all PHP versions and their installation status
php:install Install a PHP version
php:update Update a PHP version to the latest patch release
php:extension:install Install a verified Xdebug or SPX module for Yard's PHP
php:extensions Show managed debugger/profiler artifact compatibility
and load status
NODE.JS VERSION MANAGEMENT SUBCOMMANDS:
node:list List the installed Node.js versions and the default
version
node:install Install a Node.js version or update a major version
to its latest release
isolate-node Use a specific Node.js version for the current
directory (.nvmrc)
unisolate-node Remove the Node.js version isolation for the current
directory
isolated-node List all sites using isolated Node.js versions
SSL/TLS SUBCOMMANDS:
secure Generate a trusted TLS certificate for the current
(or given) site
unsecure Remove the TLS certificate and the HTTPS redirect of
a site
secured List all secured sites with their certificate
expiration dates
PROXIES SUBCOMMANDS:
proxy Create an nginx proxy site for the specified host
(Reverb, Docker containers…)
unproxy Remove an nginx proxy configuration
proxies Display all configured proxy sites
SERVICES SUBCOMMANDS:
services:list List all installed service instances and their status
services:available List all service types that can be created
services:versions List all available versions for a service type
services:create Create a new service instance
services:start Start a service instance
services:stop Stop a service instance
services:clone Clone a service instance including its data and
configuration
services:delete Delete a service and all its data
MAIL SUBCOMMANDS:
mail:list List captured mails, newest first
mail:show Show a mail with sender, recipients, subject,
attachments and body
mail:latest Show the newest mail
mail:wait Wait until a new mail arrives that matches the
filters, and show it (exit code 1 after the timeout)
mail:links Print all links of a mail, one per line
mail:attachments List the attachments of a mail with their stored path
mail:attachment Copy an attachment of a mail into the current
directory or --out
mail:mailboxes List all mailboxes (the SMTP usernames applications
use)
mail:delete Delete a mail and its attachments
mail:clear Delete all captured mails, or only the mails of a
mailbox
mail:config Show the mail server host and port and the .env
values your app needs
INSIGHTS SUBCOMMANDS:
insights:list Show the captured entries of a site, grouped by
request
insights:watch Stream new entries as they arrive (Ctrl+C to stop)
insights:analyze Find N+1 queries, duplicate queries, slow queries,
errors and slow requests
insights:clear Discard the captured entries of the current site (or
--all)
insights:status Show whether Yard captures runtime context and which
sites have entries
insights:capture Show whether Yard captures runtime context, or turn
capturing on or off
DEBUGGING SUBCOMMANDS:
debug Run PHP with the site's PHP version and debug.ini
(Xdebug) loaded
coverage Run PHP commands with Xdebug coverage enabled
debug:start Start a debug session
debug:stop Stop a debug session and display the captured data
profile Profile a PHP script with SPX, e.g. `yard profile
artisan inspire`
log Tail Yard's log files (lists them without arguments)
logs Open the Log Viewer for the given site
tinker Start a Tinker session (opens Tinkerwell when
installed)
SHARING SUBCOMMANDS:
share Share a local site via an Expose tunnel
fetch-share-url Get the URL of the current Expose share tunnel
CONFIGURATION SUBCOMMANDS:
loopback Get or set the loopback address used for Yard sites
directory-listing Determine directory-listing behavior (default off: a
404 is displayed)
CORE SERVICES SUBCOMMANDS:
status Show a health check of your Yard setup
start Start all Yard services, or one of nginx, dnsmasq or
php
stop Stop all Yard services – nginx, DNS, PHP and all
services
restart Restart all Yard services
INITIALIZATION & TOOLING SUBCOMMANDS:
init Configure the project from yard.yml, or start a
wizard to create one
init:fresh Initialize a fresh yard.yml manifest file
laravel:update Update the Laravel Installer to the latest version
mcp Run Yard's MCP server over stdio (for Claude Code,
Cursor, Codex…)
See 'yard help <subcommand>' for detailed help.
yard list
OVERVIEW: List all commands
USAGE: yard list
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard park
OVERVIEW: Register the current working (or specified) directory with Yard
USAGE: yard park [<path>]
ARGUMENTS:
<path> The directory to park (defaults to the current
directory)
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard parked
OVERVIEW: Display all the current sites within parked paths
USAGE: yard parked [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard forget
OVERVIEW: Remove the current working (or specified) directory from Yard's list
of paths
USAGE: yard forget [<path>]
ARGUMENTS:
<path> The directory to forget
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard link
OVERVIEW: Link the current working directory to Yard
USAGE: yard link [<names> ...] [--secure]
ARGUMENTS:
<names> One or more domain names (without .test). Defaults to
the directory name.
OPTIONS:
--secure Secure the linked site(s) with a TLS certificate
--version Show the version.
-h, --help Show help information.
yard links
OVERVIEW: Display all of the registered Yard links
USAGE: yard links [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard unlink
OVERVIEW: Remove the specified Yard link
USAGE: yard unlink [<name>]
ARGUMENTS:
<name> The link name (defaults to the current directory name)
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard sites
OVERVIEW: List all sites that Yard is currently serving
USAGE: yard sites [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard paths
OVERVIEW: Get all of the paths registered with Yard
USAGE: yard paths [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard open
OVERVIEW: Open the site for the current (or specified) directory in your browser
USAGE: yard open [<site>]
ARGUMENTS:
<site> Site name or directory
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard edit
OVERVIEW: Open the current directory in your configured IDE
USAGE: yard edit [<site>]
ARGUMENTS:
<site> Site name or directory
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard site:info
OVERVIEW: Show everything about a site: URL, PHP and Node.js versions,
services, capabilities and workspaces
USAGE: yard site:info [--site <site>] [--json]
OPTIONS:
--site <site> The site name
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard site:env
OVERVIEW: Read and edit the .env file of a site (keeps comments and order)
Actions: list, get KEY, set KEY VALUE, unset KEY
USAGE: yard site:env [<action>] [<key>] [<value>] [--site <site>] [--json]
ARGUMENTS:
<action> list, get, set or unset (default: list)
<key> The variable name
<value> The value for `set`
OPTIONS:
--site <site> The site name
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard site:services
OVERVIEW: Show or change the database, queue, cache and broadcasting service of
a site
USAGE: yard site:services [<category>] [<value>] [--site <site>] [--database <database>] [--json]
ARGUMENTS:
<category> database, queue, cache or broadcasting
<value> A built-in option (sqlite, sync, database, array,
file, log, null), `unmanaged`, or the name, type or
ID of an installed service
OPTIONS:
--site <site> The site name
--database <database> Database name to use for SQL servers
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard site-information
OVERVIEW: Display information about the specified site as JSON (Laravel: php
artisan about)
USAGE: yard site-information [<site>]
ARGUMENTS:
<site> Site name
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard which
OVERVIEW: Display which Yard driver serves the current working directory
USAGE: yard which
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard site:doctor
OVERVIEW: Check a project's environment without changing it
USAGE: yard site:doctor [<site>] [--json] [--live]
ARGUMENTS:
<site>
OPTIONS:
--json
--live Also send a bounded HEAD request to the project's
local web server.
--version Show the version.
-h, --help Show help information.
yard site:report
OVERVIEW: Export a consistent, redacted project test report
USAGE: yard site:report [<site>] --output <output> [--database <database>] [--attach <attach> ...] [--running]
ARGUMENTS:
<site>
OPTIONS:
--output <output> New output directory; existing paths are never
overwritten.
--database <database> Optional Yard findings SQLite database (online
backup, source unchanged).
--attach <attach> Log or screenshot to attach; repeat for multiple
files.
--running Mark this report provisional because execution is
still active.
--version Show the version.
-h, --help Show help information.
yard studio
OVERVIEW: Open Yard Studio for the current or given site in your browser
USAGE: yard studio [<site>]
ARGUMENTS:
<site> Site name
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard ai:models
OVERVIEW: List the safe model catalogue discovered from OpenCode.
USAGE: yard ai:models [--refresh] [--tool <tool>] [--json]
OPTIONS:
--refresh Refresh from OpenCode's current available inventory.
--tool <tool> OpenCode executable to inspect when refreshing.
--json Output the timestamped catalogue as JSON.
--version Show the version.
-h, --help Show help information.
yard project:start
OVERVIEW: Start this project's configured frontend and Laravel workers
USAGE: yard project:start [<site>]
ARGUMENTS:
<site>
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard project:stop
OVERVIEW: Stop this project's processes while keeping shared services running
USAGE: yard project:stop [<site>]
ARGUMENTS:
<site>
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard project:processes
OVERVIEW: Show this project's supervised processes
USAGE: yard project:processes [<site>]
ARGUMENTS:
<site>
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard project:configure
OVERVIEW: Choose which processes start with a project
USAGE: yard project:configure [<site>] [--frontend] [--no-frontend] [--queue] [--no-queue] [--scheduler] [--no-scheduler] [--broadcasting] [--no-broadcasting]
ARGUMENTS:
<site>
OPTIONS:
--frontend/--no-frontend
--queue/--no-queue
--scheduler/--no-scheduler
--broadcasting/--no-broadcasting
--version Show the version.
-h, --help Show help information.
yard project:isolate
OVERVIEW: Separate this Laravel project's database, cache, queue and sessions
(SQL databases start empty)
USAGE: yard project:isolate [<site>]
ARGUMENTS:
<site>
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard project:unisolate
OVERVIEW: Restore the previous project connection while retaining isolated data
USAGE: yard project:unisolate [<site>]
ARGUMENTS:
<site>
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard audit
OVERVIEW: Audit a project's locked Composer and JavaScript dependencies
USAGE: yard audit [--site <site>] [--json]
OPTIONS:
--site <site> Site name (defaults to the current directory)
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard db:snapshot
OVERVIEW: Create a named database restore point
USAGE: yard db:snapshot <name> [--site <site>] [--json]
ARGUMENTS:
<name> Restore point name
OPTIONS:
--site <site> Site name
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard db:snapshots
OVERVIEW: List database restore points for a project
USAGE: yard db:snapshots [--site <site>] [--json]
OPTIONS:
--site <site> Site name
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard db:restore
OVERVIEW: Restore a project's database, first saving its current state
USAGE: yard db:restore <id> [--site <site>] [--force]
ARGUMENTS:
<id> Restore point ID
OPTIONS:
--site <site> Site name
--force Confirm replacing the current database
--version Show the version.
-h, --help Show help information.
yard sail:enable
OVERVIEW: Serve a Laravel Sail project from its Docker containers (assigns free
ports, updates .env, starts Sail)
USAGE: yard sail:enable [<site>] [--no-start]
ARGUMENTS:
<site> The site name (defaults to the current directory)
OPTIONS:
--no-start Don't start the containers
--version Show the version.
-h, --help Show help information.
yard sail:disable
OVERVIEW: Stop serving a site from Sail: stops the containers and restores the
.env values Yard changed
USAGE: yard sail:disable [<site>]
ARGUMENTS:
<site> The site name (defaults to the current directory)
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard sail:status
OVERVIEW: Show the Laravel Sail state of a site
USAGE: yard sail:status [<site>] [--json]
ARGUMENTS:
<site> The site name (defaults to the current directory)
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard sail:start
OVERVIEW: Start the Sail containers of a site
USAGE: yard sail:start [<site>]
ARGUMENTS:
<site> The site name (defaults to the current directory)
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard sail:stop
OVERVIEW: Stop the Sail containers of a site
USAGE: yard sail:stop [<site>]
ARGUMENTS:
<site> The site name (defaults to the current directory)
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard workspace
OVERVIEW: Create a new workspace for the current site (inside a git worktree:
register it)
USAGE: yard workspace [<name>] [--database <database>] [--no-migrate] [--local] [--secure] [--no-secure] [--site <site>] [--json]
ARGUMENTS:
<name> Workspace name – used for the branch and the domain
(random when omitted)
OPTIONS:
--database <database> How the workspace gets its database: shared, clone
(copy) or empty
--no-migrate Don't run migrations on an empty database
--local Base the workspace on your local branch, including
unpushed commits
--secure/--no-secure Force HTTPS on or off, regardless of the parent site
--site <site> The parent site
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard workspaces
OVERVIEW: List all workspaces with parent site, URL, PHP version, database and
type
USAGE: yard workspaces [--site <site>] [--json]
OPTIONS:
--site <site> Only list the workspaces of this site
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard workspace:switch
OVERVIEW: Open a new shell inside a workspace (type `exit` to return)
USAGE: yard workspace:switch [<name>]
ARGUMENTS:
<name> Workspace name or domain
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard workspace:open
OVERVIEW: Open a workspace in your browser
USAGE: yard workspace:open [<name>]
ARGUMENTS:
<name> Workspace name or domain
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard workspace:merge
OVERVIEW: Merge the branch of a workspace into the branch it was created from
USAGE: yard workspace:merge [<name>] [--push] [--delete]
ARGUMENTS:
<name> Workspace name or domain
OPTIONS:
--push Push the base branch to origin after merging
--delete Delete the workspace after merging
--version Show the version.
-h, --help Show help information.
yard workspace:delete
OVERVIEW: Delete a workspace including its site, certificate and isolated
database (the branch stays)
USAGE: yard workspace:delete [<name>] [--force] [--keep-database] [--keep-files]
ARGUMENTS:
<name> Workspace name or domain
OPTIONS:
--force Don't ask for confirmation
--keep-database Keep the isolated database
--keep-files Keep the files of a git worktree on disk
--version Show the version.
-h, --help Show help information.
yard db
OVERVIEW: Open the database of the current or given site in your database client
USAGE: yard db [<site>]
ARGUMENTS:
<site> Site
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard db:connection
OVERVIEW: Show the database connection of a site and a connection URL
USAGE: yard db:connection [--site <site>] [--json]
OPTIONS:
--site <site> Site
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard db:list
OVERVIEW: List all databases on the server that the site uses
USAGE: yard db:list [--site <site>] [--json]
OPTIONS:
--site <site> Site
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard db:use
OVERVIEW: Point the site at another database on the same server
USAGE: yard db:use <database> [--create] [--site <site>]
ARGUMENTS:
<database> Database name
OPTIONS:
--create Create the database without asking if it doesn't exist
--site <site> Site
--version Show the version.
-h, --help Show help information.
yard db:create
OVERVIEW: Create a database on the server that the site uses
USAGE: yard db:create [<database>] [--site <site>]
ARGUMENTS:
<database> Database name (defaults to DB_DATABASE)
OPTIONS:
--site <site> Site
--version Show the version.
-h, --help Show help information.
yard db:drop
OVERVIEW: Drop a database on the server that the site uses
USAGE: yard db:drop <database> [--force] [--site <site>]
ARGUMENTS:
<database> Database name
OPTIONS:
--force Allow dropping the database from the site's
DB_DATABASE
--site <site> Site
--version Show the version.
-h, --help Show help information.
yard use
OVERVIEW: Change the global PHP version used to serve sites without an isolated
version
USAGE: yard use <version>
ARGUMENTS:
<version> PHP version, e.g. 8.4
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard isolate
OVERVIEW: Use a specific PHP version for the current site (or --site)
USAGE: yard isolate <version> [--site <site>]
ARGUMENTS:
<version> PHP version, e.g. 8.3
OPTIONS:
--site <site> The site name, if it differs from the directory name
--version Show the version.
-h, --help Show help information.
yard unisolate
OVERVIEW: Revert a site back to Yard's global PHP version
USAGE: yard unisolate [--site <site>]
OPTIONS:
--site <site> The site name
--version Show the version.
-h, --help Show help information.
yard isolated
OVERVIEW: List all sites using isolated PHP versions
USAGE: yard isolated [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard php
OVERVIEW: Proxy PHP commands with the isolated site's PHP executable
USAGE: yard php [--site <site>] [<arguments> ...]
ARGUMENTS:
<arguments>
OPTIONS:
--site <site> Use the PHP version of this site
--version Show the version.
-h, --help Show help information.
yard composer
OVERVIEW: Proxy Composer commands with the isolated site's PHP executable
USAGE: yard composer [<arguments> ...]
ARGUMENTS:
<arguments>
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard which-php
OVERVIEW: Display which PHP binary Yard uses for the current directory
USAGE: yard which-php
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard ini
OVERVIEW: Open the php.ini for the current (or given) PHP version in your IDE
USAGE: yard ini [<version>]
ARGUMENTS:
<version> PHP version
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard php:list
OVERVIEW: List all PHP versions and their installation status
USAGE: yard php:list [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard php:install
OVERVIEW: Install a PHP version
USAGE: yard php:install <version>
ARGUMENTS:
<version> PHP version, e.g. 8.3
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard php:update
OVERVIEW: Update a PHP version to the latest patch release
USAGE: yard php:update <version>
ARGUMENTS:
<version> PHP version, e.g. 8.4
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard php:extension:install
OVERVIEW: Install a verified Xdebug or SPX module for Yard's PHP
USAGE: yard php:extension:install <name> [--php <php>]
ARGUMENTS:
<name> xdebug or spx
OPTIONS:
--php <php> PHP minor version, such as 8.4
--version Show the version.
-h, --help Show help information.
yard php:extensions
OVERVIEW: Show managed debugger/profiler artifact compatibility and load status
USAGE: yard php:extensions [--php <php>]
OPTIONS:
--php <php> PHP minor version
--version Show the version.
-h, --help Show help information.
yard node:list
OVERVIEW: List the installed Node.js versions and the default version
USAGE: yard node:list [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard node:install
OVERVIEW: Install a Node.js version or update a major version to its latest
release
USAGE: yard node:install <version>
ARGUMENTS:
<version> Major (22) or exact (22.11.0) version
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard isolate-node
OVERVIEW: Use a specific Node.js version for the current directory (.nvmrc)
USAGE: yard isolate-node <version> [--site <site>]
ARGUMENTS:
<version> Node.js version, e.g. 22 or 16.13.2
OPTIONS:
--site <site> The site name
--version Show the version.
-h, --help Show help information.
yard unisolate-node
OVERVIEW: Remove the Node.js version isolation for the current directory
USAGE: yard unisolate-node [--site <site>]
OPTIONS:
--site <site> The site name
--version Show the version.
-h, --help Show help information.
yard isolated-node
OVERVIEW: List all sites using isolated Node.js versions
USAGE: yard isolated-node [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard secure
OVERVIEW: Generate a trusted TLS certificate for the current (or given) site
USAGE: yard secure [<site>]
ARGUMENTS:
<site> Site name
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard unsecure
OVERVIEW: Remove the TLS certificate and the HTTPS redirect of a site
USAGE: yard unsecure [<site>]
ARGUMENTS:
<site> Site name
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard secured
OVERVIEW: List all secured sites with their certificate expiration dates
USAGE: yard secured [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard proxy
OVERVIEW: Create an nginx proxy site for the specified host (Reverb, Docker
containers…)
USAGE: yard proxy <name> <host> [--secure]
ARGUMENTS:
<name> Domain name without .test
<host> Upstream URL, e.g. http://localhost:8080
OPTIONS:
--secure Secure the proxy with a TLS certificate
--version Show the version.
-h, --help Show help information.
yard unproxy
OVERVIEW: Remove an nginx proxy configuration
USAGE: yard unproxy <name>
ARGUMENTS:
<name> Domain name without .test
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard proxies
OVERVIEW: Display all configured proxy sites
USAGE: yard proxies [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard services:list
OVERVIEW: List all installed service instances and their status
USAGE: yard services:list [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard services:available
OVERVIEW: List all service types that can be created
USAGE: yard services:available [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard services:versions
OVERVIEW: List all available versions for a service type
USAGE: yard services:versions [<type>] [--json]
ARGUMENTS:
<type> Service type, e.g. mysql
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard services:create
OVERVIEW: Create a new service instance
USAGE: yard services:create [<type>] [--version <version>] [--name <name>] [--port <port>] [--autostart] [--no-autostart] [--https] [--json]
ARGUMENTS:
<type> Service type, e.g. mysql
OPTIONS:
--version <version> Version (defaults to the latest)
--name <name> Instance name
--port <port> Port (defaults to a free port)
--autostart/--no-autostart
Start the service when Yard starts (default:
--autostart)
--https Serve the service over HTTPS via a .yard.test domain
(Reverb, RustFS)
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard services:start
OVERVIEW: Start a service instance
USAGE: yard services:start [<service>]
ARGUMENTS:
<service> Service name, type, ID or TYPE:PORT
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard services:stop
OVERVIEW: Stop a service instance
USAGE: yard services:stop [<service>]
ARGUMENTS:
<service> Service name, type, ID or TYPE:PORT
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard services:clone
OVERVIEW: Clone a service instance including its data and configuration
USAGE: yard services:clone [<service>]
ARGUMENTS:
<service> Service name, type, ID or TYPE:PORT
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard services:delete
OVERVIEW: Delete a service and all its data
USAGE: yard services:delete [<service>] [--force]
ARGUMENTS:
<service> Service name, type, ID or TYPE:PORT
OPTIONS:
--force Don't ask for confirmation
--version Show the version.
-h, --help Show help information.
yard mail:list
OVERVIEW: List captured mails, newest first
USAGE: yard mail:list [--mailbox <mailbox>] [--to <to>] [--from <from>] [--subject <subject>] [--since <since>] [--limit <limit>] [--json]
OPTIONS:
--mailbox <mailbox> Only mails of this mailbox (exact match)
--to <to> Recipient contains
--from <from> Sender contains
--subject <subject> Subject contains
--since <since> Only mails after a date or a time like "5 minutes ago"
--limit <limit> Maximum number of mails (default: 50)
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard mail:show
OVERVIEW: Show a mail with sender, recipients, subject, attachments and body
USAGE: yard mail:show <id> [--format <format>] [--headers]
ARGUMENTS:
<id> Mail ID
OPTIONS:
--format <format> text, html, raw or json (default: text)
--headers Print all headers
--version Show the version.
-h, --help Show help information.
yard mail:latest
OVERVIEW: Show the newest mail
USAGE: yard mail:latest [--mailbox <mailbox>] [--to <to>] [--from <from>] [--subject <subject>] [--format <format>] [--headers] [--json]
OPTIONS:
--mailbox <mailbox> Only mails of this mailbox (exact match)
--to <to> Recipient contains
--from <from> Sender contains
--subject <subject> Subject contains
--format <format> text, html, raw or json (default: text)
--headers Print all headers
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard mail:wait
OVERVIEW: Wait until a new mail arrives that matches the filters, and show it
(exit code 1 after the timeout)
USAGE: yard mail:wait [--mailbox <mailbox>] [--to <to>] [--from <from>] [--subject <subject>] [--timeout <timeout>] [--format <format>] [--json]
OPTIONS:
--mailbox <mailbox> Only mails of this mailbox (exact match)
--to <to> Recipient contains
--from <from> Sender contains
--subject <subject> Subject contains
--timeout <timeout> Timeout in seconds (default: 30)
--format <format> text, html, raw or json (default: text)
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard mail:links
OVERVIEW: Print all links of a mail, one per line
USAGE: yard mail:links <id> [--json]
ARGUMENTS:
<id> Mail ID
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard mail:attachments
OVERVIEW: List the attachments of a mail with their stored path
USAGE: yard mail:attachments <id> [--json]
ARGUMENTS:
<id> Mail ID
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard mail:attachment
OVERVIEW: Copy an attachment of a mail into the current directory or --out
USAGE: yard mail:attachment <id> <name> [--out <out>]
ARGUMENTS:
<id> Mail ID
<name> Attachment file name
OPTIONS:
--out <out> Target directory or file
--version Show the version.
-h, --help Show help information.
yard mail:mailboxes
OVERVIEW: List all mailboxes (the SMTP usernames applications use)
USAGE: yard mail:mailboxes [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard mail:delete
OVERVIEW: Delete a mail and its attachments
USAGE: yard mail:delete <id>
ARGUMENTS:
<id> Mail ID
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard mail:clear
OVERVIEW: Delete all captured mails, or only the mails of a mailbox
USAGE: yard mail:clear [<mailbox>]
ARGUMENTS:
<mailbox> Mailbox
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard mail:config
OVERVIEW: Show the mail server host and port and the .env values your app needs
USAGE: yard mail:config [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard insights:list
OVERVIEW: Show the captured entries of a site, grouped by request
USAGE: yard insights:list [--site <site>] [--all] [--type <type>] [--after <after>] [--limit <limit>] [--json]
OPTIONS:
--site <site> The site (defaults to the site in the current
directory)
--all All sites
--type <type> Only one type: dump, query, job, view, http, request,
log or cache
--after <after> Only entries after this cursor
--limit <limit> Maximum number of requests
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard insights:watch
OVERVIEW: Stream new entries as they arrive (Ctrl+C to stop)
USAGE: yard insights:watch [--site <site>] [--all] [--type <type>] [--json]
OPTIONS:
--site <site> The site (defaults to the site in the current
directory)
--all All sites
--type <type> Only one type: dump, query, job, view, http, request,
log or cache
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard insights:analyze
OVERVIEW: Find N+1 queries, duplicate queries, slow queries, errors and slow
requests
USAGE: yard insights:analyze [--site <site>] [--after <after>] [--json]
OPTIONS:
--site <site> The site
--after <after> Only analyze entries after this cursor (from a
previous run)
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard insights:clear
OVERVIEW: Discard the captured entries of the current site (or --all)
USAGE: yard insights:clear [--site <site>] [--all]
OPTIONS:
--site <site> The site
--all All sites
--version Show the version.
-h, --help Show help information.
yard insights:status
OVERVIEW: Show whether Yard captures runtime context and which sites have
entries
USAGE: yard insights:status [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard insights:capture
OVERVIEW: Show whether Yard captures runtime context, or turn capturing on or
off
USAGE: yard insights:capture [<state>]
ARGUMENTS:
<state> on or off
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard debug
OVERVIEW: Run PHP with the site's PHP version and debug.ini (Xdebug) loaded
USAGE: yard debug [<arguments> ...]
ARGUMENTS:
<arguments>
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard coverage
OVERVIEW: Run PHP commands with Xdebug coverage enabled
USAGE: yard coverage [<arguments> ...]
ARGUMENTS:
<arguments>
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard debug:start
OVERVIEW: Start a debug session
USAGE: yard debug:start [--site <site>]
OPTIONS:
--site <site> The site
--version Show the version.
-h, --help Show help information.
yard debug:stop
OVERVIEW: Stop a debug session and display the captured data
USAGE: yard debug:stop [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard profile
OVERVIEW: Profile a PHP script with SPX, e.g. `yard profile artisan inspire`
USAGE: yard profile [--live] [<arguments> ...]
ARGUMENTS:
<arguments>
OPTIONS:
--live Print profiling information regularly for
long-running scripts
--version Show the version.
-h, --help Show help information.
yard log
OVERVIEW: Tail Yard's log files (lists them without arguments)
USAGE: yard log [<service>] [--lines <lines>]
ARGUMENTS:
<service> A service like nginx, php-fpm, mysql
OPTIONS:
-l, --lines <lines> Number of lines to show (default: 50)
--version Show the version.
-h, --help Show help information.
yard logs
OVERVIEW: Open the Log Viewer for the given site
USAGE: yard logs [<site>]
ARGUMENTS:
<site> Site
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard tinker
OVERVIEW: Start a Tinker session (opens Tinkerwell when installed)
USAGE: yard tinker [<site>]
ARGUMENTS:
<site> Site
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard share
OVERVIEW: Share a local site via an Expose tunnel
Examples: yard share · yard share https://example-site.test
--subdomain=my-project --server=us-1 · yard share --basicAuth="user:password"
USAGE: yard share [<arguments> ...]
ARGUMENTS:
<arguments>
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard fetch-share-url
OVERVIEW: Get the URL of the current Expose share tunnel
USAGE: yard fetch-share-url
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard loopback
OVERVIEW: Get or set the loopback address used for Yard sites
USAGE: yard loopback [<address>]
ARGUMENTS:
<address> IP address, e.g. 127.0.0.1
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard directory-listing
OVERVIEW: Determine directory-listing behavior (default off: a 404 is displayed)
USAGE: yard directory-listing [<state>]
ARGUMENTS:
<state> on or off
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard status
OVERVIEW: Show a health check of your Yard setup
USAGE: yard status [--json]
OPTIONS:
--json Print machine-readable JSON output.
--version Show the version.
-h, --help Show help information.
yard start
OVERVIEW: Start all Yard services, or one of nginx, dnsmasq or php
USAGE: yard start [<service>]
ARGUMENTS:
<service> nginx, dnsmasq or php
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard stop
OVERVIEW: Stop all Yard services – nginx, DNS, PHP and all services
USAGE: yard stop
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard restart
OVERVIEW: Restart all Yard services
USAGE: yard restart
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard init
OVERVIEW: Configure the project from yard.yml, or start a wizard to create one
USAGE: yard init [--fresh]
OPTIONS:
--fresh Overwrite an existing yard.yml with a fresh one
--version Show the version.
-h, --help Show help information.
yard init:fresh
OVERVIEW: Initialize a fresh yard.yml manifest file
USAGE: yard init:fresh
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard laravel:update
OVERVIEW: Update the Laravel Installer to the latest version
USAGE: yard laravel:update
OPTIONS:
--version Show the version.
-h, --help Show help information.
yard mcp
OVERVIEW: Run Yard's MCP server over stdio (for Claude Code, Cursor, Codex…)
USAGE: yard mcp [--project <project>] [--read-only]
OPTIONS:
--project <project> Restrict this MCP connection to a project directory
(also supported through SITE_PATH).
--read-only Allow inspection and preview captures, and reject
tools that change state.
--version Show the version.
-h, --help Show help information.