> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Laravel Console Starter

> 以 artisan 命令为主的 Laravel starter kit。可以在 GitHub Actions 上定时执行，并通过通知发送结果。

## 概览

[laravel-console-starter](https://github.com/invokable/laravel-console-starter) 是一个 starter kit，可帮助你加速开发以自定义 artisan 命令为核心的 Laravel 应用。

它并不是用于构建独立 CLI 工具，而是让你充分利用 Laravel 框架的整体生态（依赖注入、通知、调度、测试），快速构建控制台应用。典型的用例是：在 GitHub Actions 上定时执行，并通过邮件、Slack 等发送执行结果。

## 环境要求

* PHP `^8.3`
* Laravel Framework `^13.0`
* Laravel Installer `^5.24`

## 安装

```bash theme={null}
laravel new --using=revolution/laravel-console-starter --no-interaction my-app
```

安装完成后的主要目录结构：

```
my-app/
├── app/Console/Commands/   # 自定义 artisan 命令
├── .github/workflows/
│   └── cron.yml            # GitHub Actions 定时示例
├── config/                 # 应用配置
└── routes/console.php      # 命令注册
```

## 主要特点

<Columns cols={3}>
  <Card title="面向控制台应用" icon="terminal">
    去除 Web 相关的开销，让你专注于 artisan 命令开发。
  </Card>

  <Card title="GitHub Actions 调度" icon="clock">
    无需服务器 cron 任务。默认已经包含 `.github/workflows/cron.yml` 配置示例。
  </Card>

  <Card title="利用 Laravel 生态" icon="layers">
    通知、HTTP 客户端、测试、DI 容器等 Laravel 的丰富特性都可以直接使用。
  </Card>
</Columns>

## 快速上手

### 创建命令

```bash theme={null}
php artisan make:command Hello --command=hello
```

会生成 `app/Console/Commands/Hello.php`。在 `handle()` 方法中实现逻辑，然后执行命令。

```bash theme={null}
php artisan hello
```

### 用 GitHub Actions 定时执行

编辑 `.github/workflows/cron.yml`，配置要执行的命令与调度计划。

```yaml theme={null}
on:
  schedule:
    - cron: '0 0 * * *'  # 每天 UTC 0 点

jobs:
  cron:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: shivammathur/setup-php@v2
        with:
          php-version: 8.5
      - run: composer install --no-dev -q
      - run: cp .env.example .env
      - run: php artisan key:generate
      - run: php artisan your:command
```

### 发送通知

要将命令执行结果作为通知发送，可以用 `make:notification` 创建通知类，再通过 `Notification` facade 发送。

```bash theme={null}
php artisan make:notification TaskCompleted
```

```php theme={null}
Notification::route('mail', 'admin@example.com')
    ->notify(new TaskCompleted('任务已完成'));
```

<Tip>
  需要配置通知通道（邮件、Slack 等）时，可通过 `php artisan config:publish mail` 或 `php artisan config:publish services` 发布配置文件。
</Tip>

## 应用创意

以下是可以用这个 starter kit 构建的应用创意。

<AccordionGroup>
  <Accordion title="监控与分析">
    * 网站健康检查并通过 Slack 报警
    * 通过邮件发送服务器资源使用情况报告
    * SSL 证书到期检查与通知
    * API 响应时间监控并报警
    * 追踪竞品价格变动并通过 Discord 通知
  </Accordion>

  <Accordion title="财务与业务">
    * 通过邮件发送 Google AdSense 收益
    * 通过 Discord 通知 AWS 成本
    * 每日通过 Discord 更新加密资产组合
    * 通过 Slack 频道推送股价提醒
    * 账单支付到期提醒
    * 每月开支报告的生成与派发
  </Accordion>

  <Accordion title="数据处理与报表">
    * 清理旧日志文件并报告存储情况
    * 在不同 API 之间同步数据并通知结果
    * CSV 数据导入与处理结果通知
    * 定期导出数据并上传到云存储
  </Accordion>

  <Accordion title="内容与营销">
    * 检查网站失效链接并生成报告
    * 监控 SEO 关键词排名并推送变化
    * 每周汇总博客文章的表现指标
    * 聚合 RSS feed 内容并通知
  </Accordion>

  <Accordion title="开发与 DevOps">
    * GitHub 仓库依赖的安全告警
    * 代码库静态分析报告
    * 部署后的应用健康检查
    * API 文档变更检测与通知
  </Accordion>

  <Accordion title="AI 及其他">
    * 使用 [laravel-copilot-sdk](https://github.com/invokable/laravel-copilot-sdk) 构建 AI agent 工具
    * 使用 [laravel/mcp](https://github.com/laravel/mcp) 搭建本地 MCP 服务器
    * 监控域名到期并报警
    * 监控 Google Trends 关键词并通知
    * 生成个人支出分类洞察报告
  </Accordion>
</AccordionGroup>

## 文档

<Columns cols={2}>
  <Card title="教程" href="/zh/packages/laravel-console-starter/tutorial" icon="book-open">
    从安装到创建命令、GitHub Actions 调度、发送通知，以及实际应用示例的完整流程。
  </Card>
</Columns>

## 参考链接

* GitHub: [invokable/laravel-console-starter](https://github.com/invokable/laravel-console-starter)
* DeepWiki: [invokable/laravel-console-starter](https://deepwiki.com/invokable/laravel-console-starter)


## Related topics

- [Laravel Console Starter](/es/packages/laravel-console-starter/index.md)