PHPackages trendyminds/blacksmith-cli - 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. [Framework](/categories/framework) 4. / 5. trendyminds/blacksmith-cli ActiveProject[Framework](/categories/framework) trendyminds/blacksmith-cli ========================== A Forge-provisioning CLI tool for sandboxes 2.8.0(2mo ago)0781↓50%MITPHPPHP ^8.4.0 Since Dec 15Pushed 2mo ago2 watchersCompare [ Source](https://github.com/trendyminds/blacksmith-cli)[ Packagist](https://packagist.org/packages/trendyminds/blacksmith-cli)[ Docs](https://laravel-zero.com)[ RSS](/packages/trendyminds-blacksmith-cli/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (8)Versions (36)Used By (0) ⚒️ Blacksmith CLI ================= [](#️-blacksmith-cli) ### A Forge-provisioning CLI tool for sandboxes [](#a-forge-provisioning-cli-tool-for-sandboxes) [![The confirmation notice posted in a pull request when Blacksmith has provisioned a site to your Laravel Forge server](docs/preview.png)](docs/preview.png) ✅ Requirements -------------- [](#-requirements) When provisioning a sandbox you'll need: - A Forge API token - An ID of a Forge server to deploy to It is imperative to leverage GitHub secrets to ensure you are not commit this type of sensitive data to your codebase and potentially exposing this data to the outside world. 🚀 Creating and destroying sandboxes ----------------------------------- [](#-creating-and-destroying-sandboxes) Below is an example of a GitHub action that will create a new sandbox when it is labeled with a "sandbox" tag in the pull request. When the pull request is closed it will run the decommission action. ``` name: Sandbox on: pull_request: types: [labeled, reopened, closed] jobs: sandbox: if: contains(github.event.pull_request.labels.*.name, 'sandbox') runs-on: ubuntu-latest env: FORGE_APP_ID: app FORGE_DOMAIN: example.com FORGE_DEPLOY_SCRIPT: "npm install; npm run build" FORGE_TOKEN: ${{ secrets.BLACKSMITH_FORGE_TOKEN }} FORGE_SERVER: ${{ secrets.BLACKSMITH_SANDBOX_SERVER }} FORGE_REPO: ${{ github.repository }} FORGE_BRANCH: ${{ github.head_ref }} FORGE_PR_NUMBER: ${{ github.event.number }} FORGE_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} steps: - uses: actions/checkout@v2 - uses: shivammathur/setup-php@v2 with: php-version: 8.3 coverage: none - name: Install Blacksmith run: composer global require trendyminds/blacksmith-cli - name: Create Sandbox (If PR was just opened or reopened) if: github.event.action != 'closed' run: blacksmith create - name: Destroy Sandbox (When PR is closed) if: github.event.action == 'closed' run: blacksmith destroy ``` ⚙️ Configuration options ------------------------ [](#️-configuration-options) Environment NameDefault valueDescription`FORGE_TOKEN`The [API token](https://forge.laravel.com/docs/accounts/api) to use to authenticate to your Forge account`FORGE_SERVER`The ID of the server to use when provisioning new sites`FORGE_APP_ID`The prefix for your domain and database`FORGE_PR_NUMBER`The PR number for your sandbox pull request`FORGE_PHP_VERSION``php83`The version of PHP to use`FORGE_DOMAIN`The domain to use (Ex: `domain.com`)`FORGE_INSTALL_SSL``false`When enabled, a Let's Encrypt SSL will be provisioned for the domain`FORGE_DEPLOY_SCRIPT`Additional steps to add to your deploy process. Use `;` to delineate between steps (Ex: `npm install; npm run build`)`FORGE_ENV_VARS`Environment variables to append (or replace if they already exist)`FORGE_COMPOSER_INSTALL_ON_MOUNT``true`If `composer install` should be ran when the repo is mounted.`FORGE_ENABLE_DB``false`Whether your site needs a database. If `true` one will be created for you and shared in the post-deploy comment`FORGE_DB_PASSWORD`The master password for your `forge` database user. This will be placed into your project's .env automatically`FORGE_ALLOWED_IPS`If you would like to restrict your sandbox to specific IP addresses you may list them here (Ex: `1.1.1.1; 2.2.2.2`)`FORGE_BACKUP_PROVIDER`When set and when your sandbox uses a database it will be backed up to this provider. Accepts `s3` or `spaces``FORGE_BACKUP_REGION`The region for the backup service you are using`FORGE_BACKUP_BUCKET`The bucket to use for the backup`FORGE_BACKUP_ACCESS_KEY`The access key for connecting to the bucket`FORGE_BACKUP_SECRET_KEY`The secret key for connecting to the bucket`FORGE_GITHUB_TOKEN`Used to create a post-deploy comment within the pull request`FORGE_REPO`The GitHub repo to deploy and mount for the sandbox generation (Ex: `myorg/repo`)`FORGE_BRANCH`The branch to use when mounting your repo to the site`FORGE_POST_MOUNT_COMMANDS`Commands to run after the repository is first mounted. Use `;` to delineate between steps (Ex: `ls -lah; echo 'hi'`)`FORGE_PATH_TO_COMPOSER_FILE`The path to your composer.json file if not in the root of the project (Ex: `src/`)🔒 Backups --------- [](#-backups) Unfortunately, Forge's backup configuration and storage processes are asynchronous and, because of this, a lengthy and arbitrary `sleep()` method is used when running these. That means it's *possible* a database backup when your sandbox is decommissioned may not complete successfully. For tried-and-true backups consider running a separate backup process on Forge to ensure you have a method to restore databases if necessary. [![Statamic](docs/statamic.svg)](docs/statamic.svg) Statamic notes ------------------------------------------------------------------ [](#-statamic-notes) ### Git Automation [](#git-automation) Git automation should be enabled by including `STATAMIC_GIT_AUTOMATIC` in your environment variables and setting it to `false`. This means content commits have to be manually performed by visiting Utilties > Git. However, it *greatly* simplifies your sandbox: 1. You do not need to run Redis in every Statamic sandbox you create handling queued commits 2. You do not need to commit every single content save to your pull request if you do not queue your commits While `STATAMIC_GIT_AUTOMATIC=false` means some occasional manual labor, it makes the setup simpler and also enables you to create Statamic sandboxes that *shouldn't* have committed sandbox changes. ### Health Score 47 — FairBetter than 94% of packages Maintenance84 Actively maintained with recent releases Popularity17 Limited adoption so far Community8 Small or concentrated contributor base Maturity67 Established project with proven stability 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 ~13 days Recently: every ~101 days Total 35 Last Release 84d ago Major Versions 0.4.0 → 1.0.02024-12-16 1.4.1 → 2.0.02024-12-21 PHP version history (2 changes)0.1.0PHP ^8.2.0 2.8.0PHP ^8.4.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/51ee860b8a11c81c32b2d0bf9f90e23067fcf3cf72476bfab89913bf0e1ea3b3?d=identicon)[trendyminds](/maintainers/trendyminds) --- Top Contributors [![aaronbushnell](https://avatars.githubusercontent.com/u/315202?v=4)](https://github.com/aaronbushnell "aaronbushnell (59 commits)") --- Tags cliconsoleframeworklaravellaravel-zero ### Code Quality TestsPest Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/trendyminds-blacksmith-cli/health.svg) ``` [![Health](https://phpackages.com/badges/trendyminds-blacksmith-cli/health.svg)](https://phpackages.com/packages/trendyminds-blacksmith-cli) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)