PHPackages                             bkwld/codebasehq - 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. [Utility &amp; Helpers](/categories/utility)
4. /
5. bkwld/codebasehq

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

bkwld/codebasehq
================

Tools for integrating Laravel apps with CodebaseHQ features

4.1.2(8y ago)610.4k4[1 issues](https://github.com/BKWLD/codebasehq/issues)MITPHPPHP &gt;=5.3.0

Since May 31Pushed 8y ago9 watchersCompare

[ Source](https://github.com/BKWLD/codebasehq)[ Packagist](https://packagist.org/packages/bkwld/codebasehq)[ RSS](/packages/bkwld-codebasehq/feed)WikiDiscussions master Synced 4w ago

READMEChangelog (6)Dependencies (2)Versions (20)Used By (0)

CodebaseHQ
==========

[](#codebasehq)

This is a [Laravel Package](http://laravel.com/) that makes it easy to integrate with select [Codebase](http://www.codebasehq.com/) features:

- Pushing of exceptions, including full stack trace and all environment variables.
- A command that can be used in a deploy script to log a deployment.
- A command that can be used to comment on all tickets that were referenced in deployed git commit logs.

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

[](#installation)

1. Add it to your composer.json (`"bkwld/codebasehq": "~4.0"`) and do a composer install.
2. Add the service provider to your app.php config file providers: `Bkwld\CodebaseHQ\ServiceProvider::class,`.

Configuration
-------------

[](#configuration)

You will need to supply credentials to your CodebaseHQ account for this package to work. You can either store the following in your `.env` file (preferred) or publish and edit the config file for this package (`php artisan vendor:publish --provider=="Bkwld\CodebaseHQ\ServiceProvider"`).

- To log exceptions, **only** the `project` configs is required
- For either deploy command, your user `api` creds are needed

#### .env options

[](#env-options)

```
# CodebaseHQ settings
CODEBASE_PROJECT_SLUG=
CODEBASE_PROJECT_KEY=
CODEBASE_API_USERNAME=
CODEBASE_API_KEY=
CODEBASE_LOG_EXCEPTIONS=
```

Usage
-----

[](#usage)

### Exception Logging

[](#exception-logging)

This package listens for Laravel log events and pushes errors to CodebaseHQ. By default, exceptions fired from a `local` environment are not sent to CodebaseHQ. This can be changed by setting `CODEBASE_LOG_EXCEPTIONS` explicitly to `true` in your local `.env` file. You can control which exceptions *don't* get sent to CodebaseHQ by editing your app's `App\Exceptions\Handler::$dontReport` variable.

### Deploy notifications

[](#deploy-notifications)

DeployHQ has a "Deployments" tab, found within your repo, that lists deployments. You can add to this list using the `codebasehq:deploy` command. It accepts the following options, which mimic those found in the [API docs](http://support.codebasehq.com/kb/repositories/deployments).

- `servers` **required** - List of servers which you are deploying to (multiple servers should be comma separated, e.g. app1.myapp.com, app2.myapp.com, app3.myapp.com).
- `branch` - The branch which you are deploying. This defaults to the currently checked out branch.
- `revision` - The reference of the revision/commit you are deploying. It defaults to the HEAD commit.
- `deploy-env` - The environment you are pushing to.

Examples:

```
php artisan codebasehq:deploy app1.myapp.com
php artisan codebasehq:deploy production --branch=production
```

### Notify tickets of deployments

[](#notify-tickets-of-deployments)

This command is designed to be run as part of a deploy script and requires you using the CodebaseHQ feature of linking to tickets from commit messages (ex: \[touch:12\]). By piping the output from `git log` for the commits you are deploying to `php artisan codebasehq:deploy-tickets`, the package will scan the logs for ticket references and then update those tickets that they have been deployed. Here's some examples:

```
# Get all the commits that aren't on staging/master but are local
git log staging/master..master | php artisan codebasehq:deploy-tickets

# The same as before, but fetch first so the diff is up to date
git fetch staging && git log staging/master..master | php artisan codebasehq:deploy-tickets

# Specify which server environment you are deploying to
git fetch staging && git log staging/master..master | php artisan codebasehq:deploy-tickets --server=staging

# Save the the log before you deploy, then tell CodebaseHQ about it after
git fetch staging && git log staging/master..master > /tmp/deployed-staging-commits.log
run-deploy-code
cat /tmp/deployed-staging-commits.log | php artisan codebasehq:deploy-tickets --server=staging
rm /tmp/deployed-staging-commits.log
```

Here is an example of what will get appended to the ticket:

[![Deployed message within a ticket](https://camo.githubusercontent.com/1235f0f7d307db9addd638c87307b6fe4ec79c59fd9c824fb1928c0aec6cdbb0/687474703a2f2f662e636c2e6c792f6974656d732f333432673254306130343130336d3033317130512f504e472e706e67)](https://camo.githubusercontent.com/1235f0f7d307db9addd638c87307b6fe4ec79c59fd9c824fb1928c0aec6cdbb0/687474703a2f2f662e636c2e6c792f6974656d732f333432673254306130343130336d3033317130512f504e472e706e67)

###  Health Score

34

—

LowBetter than 75% of packages

Maintenance17

Infrequent updates — may be unmaintained

Popularity26

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 98.5% 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 ~87 days

Recently: every ~206 days

Total

19

Last Release

3212d ago

Major Versions

2.0.2 → 3.0.02013-10-28

3.2.3 → 4.0.02017-07-18

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/77567?v=4)[Robert Reinhard](/maintainers/weotch)[@weotch](https://github.com/weotch)

---

Top Contributors

[![weotch](https://avatars.githubusercontent.com/u/77567?v=4)](https://github.com/weotch "weotch (66 commits)")[![nielsfilmer](https://avatars.githubusercontent.com/u/675325?v=4)](https://github.com/nielsfilmer "nielsfilmer (1 commits)")

### Embed Badge

![Health badge](/badges/bkwld-codebasehq/health.svg)

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

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M337](/packages/psalm-plugin-laravel)[illuminate/events

The Illuminate Events package.

13557.0M2.1k](/packages/illuminate-events)[illuminate/pagination

The Illuminate Pagination package.

12234.1M1.0k](/packages/illuminate-pagination)[illuminate/pipeline

The Illuminate Pipeline package.

9349.2M273](/packages/illuminate-pipeline)[illuminate/session

The Illuminate Session package.

9939.3M829](/packages/illuminate-session)[illuminate/hashing

The Illuminate Hashing package.

6729.7M185](/packages/illuminate-hashing)

PHPackages © 2026

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