PHPackages                             thecoati/surf - 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. [DevOps & Deployment](/categories/devops)
4. /
5. thecoati/surf

ActiveProject[DevOps & Deployment](/categories/devops)

thecoati/surf
=============

Docker files for running a basic Radicle application.

471PHP

Since Apr 11Pushed 3y ago2 watchersCompare

[ Source](https://github.com/TheCoati/Surf)[ Packagist](https://packagist.org/packages/thecoati/surf)[ RSS](/packages/thecoati-surf/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Radicle Surf
============

[](#radicle-surf)

Radicle Surf is [Laravel Sail](https://github.com/laravel/sail) modified to be compatible with [Radicle](https://roots.io/radicle/).

> **Note**
> Radicle Surf is currently still under development.
> Currently only the **MySQL** service has been added.

Table of Contents
-----------------

[](#table-of-contents)

- [Introduction](#introduction)
- [Installation & Setup](#installation--setup)
    - [Configuring A Shell Alias](#configuring-a-shell-alias)

Introduction
------------

[](#introduction)

Radicle Surf is a light-weight command-line interface for setting up a Radicle Docker development environment based on [Laravel Sail](https://github.com/laravel/sail). Surf provides a great starting point for building a Radicle application using PHP, MySQL, and Redis without requiring prior Docker experience.

At its heart, Surf is the `docker-compose.yml` file and the `surf` script that is stored at the root of your project. The `surf` script provides a CLI with convenient methods for interacting with the Docker containers defined by the `docker-compose.yml` file.

Radicle Surf is supported on macOS, Linux, and Windows (via [WSL2](https://docs.microsoft.com/en-us/windows/wsl/about)).

Installation & Setup
------------------------

[](#installation--setup)

You may simply install Surf using the Composer package manager. Of course, these steps assume that your existing local development environment allows you to install Composer dependencies:

```
composer require thecoati/surf --dev
```

After Surf has been installed, you may run the `surf install`. This command will publish Surf's `docker-compose.yml` file to the root of your application:

```
./vendor/bin/surf install
```

Finally, you may start Surf.

```
./vendor/bin/surf up
```

### Configuring A Shell Alias

[](#configuring-a-shell-alias)

By default, Surf commands are invoked using the `vendor/bin/surf` script:

```
./vendor/bin/surf up
```

However, instead of repeatedly typing `vendor/bin/surf` to execute Surf commands, you may wish to configure a shell alias that allows you to execute Surf's commands more easily:

```
alias surf='[ -f surf ] && sh surf || sh vendor/bin/surf'
```

To make sure this is always available, you may add this to your shell configuration file in your home directory, such as `~/.zshrc` or `~/.bashrc`, and then restart your shell.

Once the shell alias has been configured, you may execute Surf commands by simply typing `surf`. The remainder of this documentation's examples will assume that you have configured this alias:

```
surf up
```

###  Health Score

16

—

LowBetter than 5% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity22

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/03c93602cb25b8ccd346a8ee0285c93b7abe5a894b318641a5a3ffc81ed6c267?d=identicon)[TheCoati](/maintainers/TheCoati)

---

Top Contributors

[![TheCoati](https://avatars.githubusercontent.com/u/9860488?v=4)](https://github.com/TheCoati "TheCoati (8 commits)")

---

Tags

dockerradiclesail

### Embed Badge

![Health badge](/badges/thecoati-surf/health.svg)

```
[![Health](https://phpackages.com/badges/thecoati-surf/health.svg)](https://phpackages.com/packages/thecoati-surf)
```

###  Alternatives

[deployer/deployer

Deployment Tool

11.0k25.4M207](/packages/deployer-deployer)[appwrite/server-ce

End to end backend server for frontend and mobile apps.

55.3k84.2k](/packages/appwrite-server-ce)[pragmarx/health

Laravel Server & App Health Monitor and Notifier

2.0k1.0M2](/packages/pragmarx-health)[felixfbecker/language-server-protocol

PHP classes for the Language Server Protocol

22476.7M6](/packages/felixfbecker-language-server-protocol)[heroku/heroku-buildpack-php

Toolkit for starting a PHP application locally, with or without foreman, using the same config for PHP and Apache2/Nginx as on Heroku

8161.3M10](/packages/heroku-heroku-buildpack-php)[tiamo/phpas2

PHPAS2 is a php-based implementation of the EDIINT AS2 standard

4674.7k](/packages/tiamo-phpas2)

PHPackages © 2026

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