Download the PHP package agents-ready/laravel-installer without Composer

Agents-Ready Installer

Laravel Composer package that installs Agents-Ready local-development tooling into an application.

The installer generates project-local Docker wrappers, runtime Compose files, worktree helpers, and optional agent guidance. It is Docker-first and does not require Laravel Sail, host PHP, or host Composer after the generated tooling is installed.

Status

This repository is pre-release V1 work. The public command surface is intentionally small:

The installer writes files and local state only. It does not provision Docker resources during installation. The first ./local up starts shared companions, provisions checkout databases/cache namespaces, starts runtime containers, and materializes runtime env files.

Requirements

• Laravel 12 or 13 application.
• Docker with Docker Compose v2.
• A shared Traefik companion checkout.
• A shared services companion checkout.

Most projects keep the companion checkouts next to the application checkout:

The installer always requires explicit host paths for the app checkout and both companions. This keeps Docker-based installs unambiguous and makes the generated local config reproducible.

Quick Start

Create a workspace and clone the shared companions:

Create a Laravel app with host Composer:

Install Agents-Ready:

The install command is interactive by default. It will ask for project slug, runtime, database, and optional project conventions.

Start the stack:

Verify:

No Host Composer

If the host has Docker but no PHP or Composer, use the Composer Docker image until ./local exists.

Create the Laravel app:

Require the installer:

Run the installer:

After that, use the generated wrapper:

Existing App

Install the package as a development dependency in the Laravel application:

Run the installer interactively. The three host paths are required arguments; project slug, runtime, database, and optional conventions can be selected from prompts.

For non-interactive installs, add --no-interaction and pass any desired choices as options:

When installing from Docker, --host-root should be the real host checkout path. If the Laravel app still has the skeleton Composer name laravel/laravel, Agents-Ready derives the default project slug from this host path instead of the container mount path such as /app.

Options

Runtime options:

Database options:

Optional Horizon service:

Project identity and routing:

--project-slug is the normal option for local resource identity. It is normalized, so Real App becomes real-app, and the default route domain becomes <project-slug>.localhost. --route-domain is an advanced full-domain override; it changes routing without changing the project slug.

Optional project conventions:

Existing project candidate mode:

Candidate mode writes only worktree.docker-compose.yml for review/manual integration. It does not mutate existing .env, .env.testing, Compose, Sail, Docker, wrapper, or agent files.

Generated Workflow

Common commands after installation:

Vite is explicit: ./local up does not start Vite. Use ./local assets dev when needed.

./local sail ... is a compatibility alias for the generated wrapper. After ./local up, direct docker compose ... commands also work for compatible workflows.

Identity And Env

Agents-Ready identifies checkouts by projectId + worktreeId in .agents-ready/worktree.json.

For the main checkout, both projectId and worktreeId are the project slug. Worktree route hosts are derived from the main checkout route domain.

Runtime .env files contain app/runtime compatibility values such as APP_URL, DB_*, REDIS_*, COMPOSE_PROJECT_NAME, and APP_SERVICE. Agents-Ready identity is intentionally not written into .env.

Development

This package is developed with Docker-first tooling:

Opt-in smoke checks are available:

Smoke workspaces default to /tmp/opencode/agents-ready-installer-smoke and clean recorded resources on successful runs.