-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add section on available Artisan commands
- Loading branch information
1 parent
955bf85
commit 283327d
Showing
2 changed files
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Artisan Commands | ||
|
||
Laravel comes with a powerful command line interface called [Artisan](https://laravel.com/docs/11.x/artisan). Coilpack provides additional functionality for Artisan to help you setup and interact with your ExpressionEngine installation. | ||
|
||
## Available Commands | ||
|
||
|
||
### Setup Coilpack | ||
|
||
```php | ||
php artisan coilpack | ||
``` | ||
|
||
This command will walk you through [connecting ExpressionEngine with your Laravel application](./getting-started.md). | ||
|
||
### Manage GraphQL | ||
|
||
```php | ||
php artisan coilpack:graphql --generate-token | ||
``` | ||
|
||
This command will help [secure your GraphQL endpoint](./graphql/index.md#securing-your-graphql-endpoint) by generating a token for the `COILPACK_GRAPHQL_TOKEN` variable in your environment file. | ||
|
||
### ExpressionEngine CLI | ||
|
||
``` | ||
php artisan eecli | ||
``` | ||
|
||
This command serves as a proxy to [ExpressionEngine's Command Line Interface](https://docs.expressionengine.com/latest/cli/intro.html). It is necessary to use this proxy if you wish to take advantage of Laravel code (environment/config variables, etc...) within an ExpressionEngine Command. | ||
|
||
In most cases you call the ExpressionEngine command in an identical manner just substitute `php artisan eecli` for `php eecli.php`. For example you can run an ExpressionEngine update by issuing this command `php artisan eecli update`. | ||
|
||
:::caution | ||
There are some differences between commands in ExpressionEngine and Laravel. For instance option shortcuts can only be a single letter in Artisan commands where an ExpressionEngine Command does not have this restriction. | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters