Skip to content

Commit

Permalink
Add section on available Artisan commands
Browse files Browse the repository at this point in the history
  • Loading branch information
bryannielsen committed May 22, 2024
1 parent 955bf85 commit 283327d
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/artisan.md
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.
:::
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ const sidebars = {
items: [{ type: 'autogenerated', dirName: 'guides' }],
},
'configuration',
'artisan',
'events',
'routing',
{
Expand Down

0 comments on commit 283327d

Please sign in to comment.