Download the PHP package trendyminds/blacksmith-cli without Composer

On this page you can find all versions of the php package trendyminds/blacksmith-cli. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package blacksmith-cli

⚒️ Blacksmith CLI

A Forge-provisioning CLI tool for sandboxes

✅ Requirements

When provisioning a sandbox you'll need:

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

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.

⚙️ Configuration options

Environment Name Default value Description
FORGE_TOKEN The API token to use to authenticate to your Forge account
FORGE_ORGANIZATION Your Forge organization slug. Found in the dashboard URL: forge.laravel.com/orgs/{slug}/...
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 true 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_STORAGE_PROVIDER_ID The ID of a Storage Provider configured in Forge. When set and your sandbox uses a database, the database is backed up there before the site is destroyed. The provider type, region, bucket, and credentials are configured once in the Forge dashboard.
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/)

🟢 Node version

If your project includes an .nvmrc file, Blacksmith installs the pinned Node version on every deploy using a per-site nvm. Because sandboxes run under user isolation, each site's user gets its own ~/.nvm, so the pinned version is scoped to that sandbox. Without an .nvmrc, the server's default Node is used and nvm is not installed.

This ensures FORGE_DEPLOY_SCRIPT steps such as npm install; npm run build run against the Node version your project expects.

🔒 Backups

Backups rely on a Forge Storage Provider. Create one in the Forge dashboard (configuring its provider type, region, bucket, and credentials), then reference it via FORGE_STORAGE_PROVIDER_ID. When set and your sandbox uses a database, Blacksmith creates a one-off backup configuration on destroy, triggers a backup, and then removes the configuration.

Forge's backup processes are asynchronous, so Blacksmith polls the backup until it reports as finished before removing the backup configuration and destroying the database. Backups are given up to 30 minutes to complete; if one takes longer than that the destroy will fail rather than tear down the database prematurely. 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 notes

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.

All versions of blacksmith-cli with dependencies

PHP Build Version
Package Version
Requires php Version ^8.4.0
illuminate/http Version ^12.0
illuminate/validation Version ^12.0
intonate/tinker-zero Version ^1.2
laravel/forge-sdk Version ^4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package trendyminds/blacksmith-cli contains the following files

Loading the files please wait ...