# Forge - Cli

*Source: https://forge.laravel.com/docs/cli*

---

[Laravel Forge home page](https://forge.laravel.com)
Search...
⌘KAsk AI
- [Get started](https://forge.laravel.com)
- [Get started](https://forge.laravel.com)
Search...
Navigation
Get Started
Laravel Forge CLI
[Documentation](/docs/introduction)[Knowledge Base](/docs/knowledge-base/servers)[API Reference](/docs/api-reference/introduction)
- [Blog](https://blog.laravel.com)
- [Status](https://status.on-forge.com)
##### Get Started
- [Introduction](/docs/introduction)
- [Laravel Forge CLI](/docs/cli)
- [Laravel Forge SDK](/docs/sdk)
##### Basics
- [Organizations](/docs/organizations)
- [Teams](/docs/teams)
- [Server Providers](/docs/server-providers)
- [Storage Providers](/docs/storage-providers)
- [Source Control](/docs/source-control)
- [SSH Keys](/docs/ssh)
- [Recipes](/docs/recipes)
- [API](/docs/api)
##### Servers
- [Managing Servers](/docs/servers/the-basics)
- [Server Types](/docs/servers/types)
- [Laravel VPS](/docs/servers/laravel-vps)
- [PHP](/docs/servers/php)
- [Load Balancing](/docs/servers/load-balancing)
- [Nginx Templates](/docs/servers/nginx-templates)
- [Security](/docs/servers/security)
- [Monitoring](/docs/servers/monitoring)
- [Real-Time Metrics](/docs/servers/real-time-metrics)
##### Sites
- [Managing Sites](/docs/sites/the-basics)
- [Domains](/docs/sites/domains)
- [Deployments](/docs/sites/deployments)
- [Environment Variables](/docs/sites/environment-variables)
- [Commands](/docs/sites/commands)
- [Queues](/docs/sites/queues)
- [Network](/docs/sites/network)
- [Isolation](/docs/sites/user-isolation)
- [Laravel](/docs/sites/laravel)
- [Logs](/docs/sites/logs)
##### Resources
- [Databases](/docs/resources/databases)
- [Database Backups](/docs/resources/database-backups)
- [Managed Databases](/docs/resources/managed-databases)
- [Caches](/docs/resources/caches)
- [Background Processes](/docs/resources/background-processes)
- [Scheduler](/docs/resources/scheduler)
- [Network](/docs/resources/network)
- [Packages](/docs/resources/packages)
##### Integrations
- [Envoyer](/docs/integrations/envoyer)
- [Sentry](/docs/integrations/sentry)
- [Aikido](/docs/integrations/aikido)
- [OpenClaw](/docs/integrations/openclaw)
##### Other
- [Support](/docs/support)
- [Changelog](/docs/changelog)
- [Abuse](/docs/abuse)
## On this page
- [Introduction](#introduction)
- [Installation](#installation)
- [Get started](#get-started)
- [Authenticating](#authenticating)
- [Current server & switching servers](#current-server-%26-switching-servers)
- [SSH key authentication](#ssh-key-authentication)
- [Sites](#sites)
  - [Initiating deployments](#initiating-deployments)
  - [Updating environment variables](#updating-environment-variables)
  - [Viewing application logs](#viewing-application-logs)
  - [Reviewing deployment output / logs](#reviewing-deployment-output-%2F-logs)
  - [Running commands](#running-commands)
  - [Tinker](#tinker)
- [Resources](#resources)
  - [Checking resource status](#checking-resource-status)
  - [Viewing resources logs](#viewing-resources-logs)
  - [Restarting resources](#restarting-resources)
  - [Connecting to resources locally](#connecting-to-resources-locally)
Get Started
# Laravel Forge CLI
Copy page
Laravel Forge CLI is a command-line tool that you may use to manage your Forge resources from the command-line.
Copy page
> ## Documentation Index
>
> Fetch the complete documentation index at: <https://forge.laravel.com/docs/llms.txt>
>
> Use this file to discover all available pages before exploring further.
## Laravel Forge CLI
View the Laravel Forge CLI on GitHub
## Laravel Forge API
View the Laravel Forge API documentation
## [​](#introduction) Introduction
Laravel Forge provides a command-line tool that you may use to manage your Forge servers, sites, and resources from the command-line.
## [​](#installation) Installation
> **Requires [PHP 8.0+](https://php.net/releases/)**
You may install the **[Laravel Forge CLI](https://github.com/laravel/forge-cli)** as a global [Composer](https://getcomposer.org) dependency:
```
composer global require laravel/forge-cli
```
## [​](#get-started) Get started
To view a list of all available Laravel Forge CLI commands and view the current version of your installation, you may run the `forge` command from the command-line:
```
forge
```
## [​](#authenticating) Authenticating
You will need to generate an API token to interact with the Laravel Forge CLI. Tokens are used to authenticate your account without providing personal details. API tokens can be created from [Forge’s API dashboard](https://forge.laravel.com/profile/api).
After you have generated an API token, you should authenticate with your Laravel Forge account using the login command:
```
forge login
forge login --token=your-api-token
```
Alternatively, if you plan to authenticate with Laravel Forge from your CI platform, you may set a `FORGE_API_TOKEN` environment variable in your CI build environment.
## [​](#current-server-&-switching-servers) Current server & switching servers
When managing Laravel Forge servers, sites, and resources via the CLI, you will need to be aware of your currently active server. You may view your current server using the `server:current` command. Typically, most of the commands you execute using the Forge CLI will be executed against the active server.
```
forge server:current
```
Of course, you may switch your active server at any time. To change your active server, use the `server:switch` command:
```
forge server:switch
forge server:switch staging
```
To view a list of all available servers, you may use the `server:list` command:
```
forge server:list
```
## [​](#ssh-key-authentication) SSH key authentication
Before performing any tasks using the Laravel Forge CLI, you should ensure that you have added an SSH key for the `forge` user to your servers so that you can securely connect to them. You may have already done this via the Forge UI. You may test that SSH is configured correctly by running the `ssh:test` command:
```
forge ssh:test
```
To configure SSH key authentication, you may use the `ssh:configure` command. The `ssh:configure` command accepts a `--key` option which instructs the CLI which public key to add to the server. In addition, you may provide a `--name` option to specify the name that should be assigned to the key:
```
forge ssh:configure

forge ssh:configure --key=/path/to/public/key.pub --name=sallys-macbook
```
After you have configured SSH key authentication, you may use the `ssh` command to create a secure connection to your server:
```
forge ssh

forge ssh server-name
```
## [​](#sites) Sites
To view the list of all available sites, you may use the `site:list` command:
```
forge site:list
```
### [​](#initiating-deployments) Initiating deployments
One of the primary features of Laravel Forge is deployments. Deployments may be initiated via the Forge CLI using the `deploy` command:
```
forge deploy

forge deploy example.com
```
### [​](#updating-environment-variables) Updating environment variables
You may update a site’s environment variables using the `env:pull` and `env:push` commands. The `env:pull` command may be used to pull down an environment file for a given site:
```
forge env:pull
forge env:pull pestphp.com
forge env:pull pestphp.com .env
```
Once this command has been executed, the site’s environment file will be placed in your current directory. To update the site’s environment variables, open and edit this file. When you are done editing the variables, use the `env:push` command to push the variables back to your site:
```
forge env:push
forge env:push pestphp.com
forge env:push pestphp.com .env
```
If your site is utilizing Laravel’s “configuration caching” feature or has queue workers, the new variables will not be used until the site is deployed again.
### [​](#viewing-application-logs) Viewing application logs
You may also view a site’s logs directly from the command-line. To do so, use the `site:logs` command:
```
forge site:logs
forge site:logs --follow              # View logs in realtime

forge site:logs example.com
forge site:logs example.com --follow  # View logs in realtime
```
### [​](#reviewing-deployment-output-/-logs) Reviewing deployment output / logs
When a deployment fails, you may review the output / logs via the Laravel Forge UI’s deployment history screen. You may also review the output at any time on the command-line using the `deploy:logs` command. If the `deploy:logs` command is called with no additional arguments, the logs for the latest deployment will be displayed. Or, you may pass the deployment ID to the `deploy:logs` command to display the logs for a particular deployment:
```
forge deploy:logs

forge deploy:logs 12345
```
### [​](#running-commands) Running commands
Sometimes you may wish to run an arbitrary shell command against a site. The `command` command will prompt you for the command you would like to run. The command will be run relative to the site’s root directory.
```
forge command

forge command example.com

forge command example.com --command="php artisan inspire"
```
### [​](#tinker) Tinker
As you may know, all Laravel applications include “Tinker” by default. To enter a Tinker environment on a remote server using the Laravel Forge CLI, run the `tinker` command:
```
forge tinker

forge tinker example.com
```
## [​](#resources) Resources
Laravel Forge provisions servers with a variety of resources and additional software, such as Nginx, MySQL, etc. You may use the Forge CLI to perform common actions on those resources.
### [​](#checking-resource-status) Checking resource status
To check the current status of a resource, you may use the `{resource}:status` command:
```
forge daemon:status
forge database:status

forge nginx:status

forge php:status      # View PHP status (default PHP version)
forge php:status 8.5  # View PHP 8.5 status
```
### [​](#viewing-resources-logs) Viewing resources logs
You may also view logs directly from the command-line. To do so, use the `{resource}:logs` command:
```
forge daemon:logs
forge daemon:logs --follow  # View logs in realtime

forge database:logs

forge nginx:logs         # View error logs
forge nginx:logs access  # View access logs

forge php:logs           # View PHP logs (default PHP version)
forge php:logs 8.5       # View PHP 8.5 logs
```
### [​](#restarting-resources) Restarting resources
Resources may be restarted using the `{resource}:restart` command:
```
forge daemon:restart

forge database:restart

forge nginx:restart

forge php:restart      # Restarts PHP (default PHP version)
forge php:restart 8.5  # Restarts PHP 8.5
```
### [​](#connecting-to-resources-locally) Connecting to resources locally
You may use the `{resource}:shell` command to quickly access a command line shell that lets you interact with a given resource:
```
forge database:shell
forge database:shell my-database-name
forge database:shell my-database-name --user=my-user
```
Was this page helpful?
YesNo
[Introduction](/docs/introduction)[Laravel Forge SDK](/docs/sdk)
⌘I
Assistant
Responses are generated using AI and may contain mistakes.