PHPackages                             artisan-build/agent-os-installer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. artisan-build/agent-os-installer

ActiveLibrary

artisan-build/agent-os-installer
================================

Laravel package for installing Agent OS and related code quality tools

0.2.1(6mo ago)025.7k↑88.2%MITPHPPHP ^8.3

Since Oct 29Pushed 1mo agoCompare

[ Source](https://github.com/artisan-build/agent-os-installer)[ Packagist](https://packagist.org/packages/artisan-build/agent-os-installer)[ RSS](/packages/artisan-build-agent-os-installer/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (7)Versions (6)Used By (0)

Agent OS Installer
==================

[](#agent-os-installer)

A Laravel package for installing Agent OS and related code quality tools into Laravel applications.

Installation
------------

[](#installation)

This package is designed to be used during the initial setup of Agent OS in Laravel projects.

Requirements
------------

[](#requirements)

### Minimum Requirements (for target projects)

[](#minimum-requirements-for-target-projects)

- PHP 8.2+
- Laravel 11.0+
- Composer 2.0+

### Recommended

[](#recommended)

- PHP 8.4+
- Laravel 12.0+

What Gets Installed
-------------------

[](#what-gets-installed)

The installer will set up the following tools and configurations:

### Code Quality Tools

[](#code-quality-tools)

- **PestPHP** - Modern testing framework (minimum: Pest 3.0)
- **Laravel Pint** - Code formatting and style fixing
- **PHPStan/Larastan** - Static analysis (minimum: level 5, recommended: level 6)
- **Rector** - Automated code refactoring with Laravel rules
- **Tighten Duster** - Unified code quality command (runs Pint, TLINT, and more)

### Development Tools

[](#development-tools)

- **Laravel Debugbar** - Development debugging tool
- **Laravel IDE Helper** - IDE autocompletion for Laravel

### Composer Scripts

[](#composer-scripts)

The installer adds standardized Composer scripts to your `composer.json`:

- `composer test` - Run tests with config clearing
- `composer test-parallel` - Run tests in parallel
- `composer lint` - Fix code style with Duster
- `composer rector` - Run Rector refactoring
- `composer stan` - Run PHPStan static analysis
- `composer ready` - Run full quality check (rector, lint, stan, test)
- `composer report` - Run quality check with non-blocking failures
- `composer coverage` - Generate test coverage report
- `composer coverage-html` - Generate HTML coverage report
- `composer types` - Check type coverage

**Note:** If existing scripts conflict with these definitions, you'll be prompted to confirm overwriting them. These scripts are required for Agent OS commands to function properly.

### Agent OS Framework

[](#agent-os-framework)

- **Agent OS** - AI-assisted development framework from [Builder Methods](https://buildermethods.com/)

We install our own opinionated fork of Agent OS, which includes a Laravel profile. This fork is available on [GitHub](https://github.com/artisan-build/agent-os). If you already have Agent OS installed, we will simply copy our Laravel profile into your existing Agent OS installation. If you already have a profile called Laravel, we will assume you have things set up the way you want them and completely skip the Agent OS installation portion of this.

The reason that we install all of those code quality tools is that in our Laravel profile, the instructions mention things like `composer report` and `composer ready`, which are scripts that run all this tooling to ensure that everything is truly up to our specifications.

Agent OS Web Viewer
-------------------

[](#agent-os-web-viewer)

This package includes a web viewer for browsing Agent OS documentation directly in your Laravel application. The viewer provides a GitHub-style interface for viewing your product documentation, specs, and other Agent OS files.

### Features

[](#features)

- **GitHub-Flavored Markdown Rendering** - Full GFM support with syntax highlighting
- **Dark Mode Support** - Automatic theme switching based on system preference
- **Product Documentation View** - Concatenated view of `.agent-os/product/` folder
- **Spec Viewer** - Unified view of specs with automatic concatenation of spec.md, sub-specs, and tasks
- **Smart Internal Links** - `@.agent-os/...` references automatically convert to anchor links for same-page navigation
- **Sidebar Navigation** - Browse all specs, product docs, and README
- **Access Control** - Configurable middleware with gate support

### Configuration

[](#configuration)

The viewer can be configured via `config/agent-os-installer.php`:

```
'viewer' => [
    'enabled' => env('AGENT_OS_VIEWER_ENABLED', true),
    'route_prefix' => env('AGENT_OS_ROUTE_PREFIX', 'agent-os'),
    'middleware' => ['web'],
    'gate' => null, // Optional gate name for authorization
    'paths' => [], // Additional documentation paths to include
    'default_view' => 'product', // 'product' or 'readme'
],
```

### Environment Variables

[](#environment-variables)

- `AGENT_OS_VIEWER_ENABLED` - Enable/disable the viewer (default: `true`)
- `AGENT_OS_ROUTE_PREFIX` - Route prefix for the viewer (default: `agent-os`)

### Access Control

[](#access-control)

By default, the viewer is accessible in local environments and requires authentication in production. You can customize this by:

1. **Custom Gate**: Set a gate name in the config:

```
'viewer' => [
    'gate' => 'view-agent-os-docs',
],
```

Then define the gate in your `AuthServiceProvider`:

```
Gate::define('view-agent-os-docs', function ($user) {
    return $user->is_admin;
});
```

2. **Custom Middleware**: Add your own middleware to the config:

```
'viewer' => [
    'middleware' => ['web', 'auth', 'can:view-docs'],
],
```

### Usage

[](#usage)

Once installed, visit `/agent-os` (or your configured route prefix) in your browser to view the documentation.

### Internal Reference Links

[](#internal-reference-links)

The viewer supports Agent OS reference links using the `@` prefix:

```
See @.agent-os/product/mission.md for more details.
Review @.agent-os/specs/2025-11-01-my-spec/sub-specs/technical-spec.md
Check @.agent-os/specs/2025-11-01-my-spec/tasks.md for task list
```

Within the same spec, these automatically become anchor links for smooth in-page navigation.

License
-------

[](#license)

MIT

###  Health Score

43

—

FairBetter than 91% of packages

Maintenance79

Regular maintenance activity

Popularity29

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

5

Last Release

196d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/55eed7400c452edf7e7adfa4f1c6676b65b5ce1867fff6bddcb80b1bb45360af?d=identicon)[edgrosvenor](/maintainers/edgrosvenor)

---

Top Contributors

[![edgrosvenor](https://avatars.githubusercontent.com/u/1053395?v=4)](https://github.com/edgrosvenor "edgrosvenor (33 commits)")

###  Code Quality

TestsPest

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/artisan-build-agent-os-installer/health.svg)

```
[![Health](https://phpackages.com/badges/artisan-build-agent-os-installer/health.svg)](https://phpackages.com/packages/artisan-build-agent-os-installer)
```

###  Alternatives

[spatie/laravel-livewire-wizard

Build wizards using Livewire

4061.0M4](/packages/spatie-laravel-livewire-wizard)[illuminate/mail

The Illuminate Mail package.

5910.1M391](/packages/illuminate-mail)[kirschbaum-development/commentions

A package to allow you to create comments, tag users and more

12369.2k](/packages/kirschbaum-development-commentions)[calebdw/larastan-livewire

A Larastan / PHPStan extension for Livewire.

43482.4k3](/packages/calebdw-larastan-livewire)[bjuppa/laravel-blog

Add blog functionality to your Laravel project

483.3k2](/packages/bjuppa-laravel-blog)[tomshaw/electricgrid

A feature-rich Livewire package designed for projects that require dynamic, interactive data tables.

116.6k](/packages/tomshaw-electricgrid)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)