Download the PHP package sven/forge-cli without Composer

Forge CLI

⚠️ Notice

This package is abandoned: Use the official laravel/forge-cli instead.

Interact with your Laravel Forge servers and sites via the command line with this package. Create and list servers, add sites, and install repositories all without leaving the comfort of your command line. An overview of all available commands can be found here.

Installation

Via composer:

Setup

Ensure Composer's global bin directory is included in your path. This directory is located at ~/.composer/vendor/bin on macOS / Linux, and at %APPDATA%/Composer/vendor/bin on Windows.

Before using the commands, you have to provide an API token. To generate a new token, visit this page, give the token a name (like ForgeCLI) and click "Create new token".

Then, execute the following command on the command line:

When prompted for it, paste in your API key. You may optionally pass in the key directly as an argument to the command:

If the API key on your Forge account changed, you'll need to run the same command again. A hidden configuration file will be saved to your home directory (~/.forge.json on macOS / Linux, %USERPROFILE%/.forge.json on Windows).

Usage

A list of commands with their explanation can be found below. You can also find a list of commands and their arguments by installing the package and running forge list or forge help {command}.

Servers

server:list

Show all servers associated with your account.

server:show

Show information about one of your servers.

server:make

Create a new server.

server:update

Update the metadata on one of your servers. This will only update the data in Forge, it won't make any actual changes to your server.

server:reboot

Reboot one of your servers. You will need to confirm your action.

server:delete

Delete an existing server. You will need to confirm your action.

Sites

site:list

Show all sites installed on a server.

site:show

Show information about a site on a specified server.

site:make

Create a new site on one of your servers. Use --alias to include one or more additional domains.

site:update

Update a site on a specified server.

site:deploy

Deploy the given site.

site:delete

Delete a site. You will need to confirm your action.

Services

service:reboot

Reboot a service on the given server. Supported services are nginx, mysql, and postgres.

service:stop

Stop a service on the given server. Supported services are nginx, mysql, and postgres.

service:install

Install a service on the given server. Supported services are blackfire and papertrail. The --host option is only required when installing Papertrail, --server-id and --server-token are only required when installing Blackfire.

service:uninstall

Uninstall a service from the given server. Supported services are blackfire and papertrail.

Daemons

daemon:list

List all active daemons on the given server.

daemon:show

Show information about the given daemon.

daemon:make

Create a new daemon to run on the given server. If no user is supplied, it defaults to forge.

daemon:reboot

Reboot the given daemon. You will need to confirm your action.

daemon:delete

Delete the given daemon from the given server. You will need to confirm your action.

MySQL Users

mysql-user:make

Create a new MySQL user with access to the given databases.

mysql-user:list

List all MySQL users on the given server.

mysql-user:show

Show information about the given MySQL user.

mysql-user:update

Update the databases a MySQL user has access to.

mysql-user:delete

Delete the given MySQL user from your server. You will need to confirm your action.

Firewall Rules

rule:make

Create a new firewall rule.

rule:list

Show all firewall rules.

rule:show

Show information about one of your firewall rules.

rule:delete

Delete a given firewall rule from one of your servers. You will need to confirm your action.

Scheduled Jobs

job:make

Create a new scheduled job.

job:list

Show all scheduled jobs.

job:show

Show information about one of your scheduled jobs.

job:delete

Delete a given scheduled job from one of your servers. You will need to confirm your action.

Databases

database:make

Create a new database. The flags --user and --password must either both be present or both be absent.

database:list

Show all databases on a server.

database:show

Show information about one of your databases.

database:delete

Delete a given database from one of your servers. You will need to confirm your action.

SSL Certificates

certificate:list

Show all certificates installed on the given site.

certificate:show

Show information about the specified certificate.

certificate:make

Create a new certificate for one of your sites.

certificate:activate

Activate a currently installed SSL certificate.

certificate:install

Install a certificate on the given site.

certificate:delete

Revoke and remove a certificate from the given site. You will need to confirm you action.

SSH Keys

key:make

Create a new SSH key and add it to a server.

If you do not supply the --file option, the command will look in STDIN for any input:

key:list

Show all SSH keys installed on a server.

key:show

Show information about one of your SSH keys.

key:delete

Delete a given SSH key from one of your servers. You will need to confirm your action.

Workers

worker:make

Create a new worker.

worker:list

Show all workers installed on a site.

worker:show

Show information about one of your workers.

worker:delete

Delete a given worker from one of your sites. You will need to confirm your action.

worker:reboot

Reboot one of your workers. You will need to confirm your action.

quickdeploy:enable

Enable quick deployment for the given site.

quickdeploy:disable

Disable quick deployment for the given site.

deploy-script:get

Get the deployment script of the given site.

The output will be written to STDOUT, so you can save it to a file directly:

deploy-script:set

Update the deployment script of the given site.

If you do not supply the --file option, the command will look in STDIN for any input:

deploy-log

Show the latest deployment log.

The output will be written to STDOUT, so you can save it to a file directly:

reset-deploy-state

Reset the state of the deployment.

Configuration

env:get

Get the environment file of one of your sites.

The output will be written to STDOUT, so you can save it to a file directly:

env:set

Update the environment file for one of your sites.

If you do not supply the --file option, the command will look in STDIN for any input:

nginx-config:get

Get the nginx config file of one of your sites.

The output will be written to STDOUT, so you can save it to a file directly:

nginx-config:set

Update the nginx config file for one of your sites.

If you do not supply the --file option, the command will look in STDIN for any input:

Projects

git:install

Install a git project on the given site.

The provider option can be either github (default) or custom.

git:delete

Remove a git project from the given site. You will need to confirm your action.

wordpress:install

Install WordPress on the given site.

wordpress:delete

Remove a WordPress project from the given site. You will need to confirm your action.

Recipes

recipe:make

Create a new recipe.

If you do not supply the --script option, the command will look in STDIN for any input:

recipe:list

Show all recipes in your Forge account.

recipe:show

Show information about one of your recipes.

recipe:run

Run the given recipe on the specified server(s).

recipe:delete

Delete the given recipe. You will need to confirm your action.

Credentials

Show all credentials associated with your account.

Contributing

All contributions (pull requests, issues and feature requests) are welcome. Make sure to read through the CONTRIBUTING.md first, though. See the contributors page for all contributors.

License

sven/forge-cli is licensed under the MIT License (MIT). Please see the license file for more information.