KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #claude-code #codex #dsh #dsh-plugin #ai-agent #ai-agents #deepseek-harness #agent-skills #macos #cli

SchedulerBundle

★ 116 Open GitHub ↗

Repetitive tasks as a breath in Symfony

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![SchedulerBundleHero](https://raw.githubusercontent.com/Guikingone/SchedulerBundle/main/assets/SchedulerBundle.png)

<div align="center">
    <img src="https://img.shields.io/packagist/v/guikingone/scheduler-bundle?style=flat" alt="Current bundle version" />
    <img src="https://img.shields.io/packagist/dt/guikingone/scheduler-bundle" alt="Packagist Downloads" />
    <img src="https://img.shields.io/packagist/php-v/guikingone/scheduler-bundle?style=flat" alt="PHP version requirement" />
    <a href="https://insight.symfony.com/projects/825be328-29f8-44f7-a750-f82818ae9111"><img src="https://img.shields.io/symfony/i/grade/825be328-29f8-44f7-a750-f82818ae9111?style=flat" alt="Symfony Insight" /></a>
    <img src="https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2FGuikingone%2FSchedulerBundle%2Fmain" alt="Infection score" />
    <img src="https://img.shields.io/github/license/Guikingone/SchedulerBundle?style=flat" alt="License" />
    <a href="https://app.fossa.com/projects/git%2Bgithub.com%2FGuikingone%2FSchedulerBundle?ref=badge_shield"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2FGuikingone%2FSchedulerBundle.svg?type=shield" alt="FOSSA status" /></a>
    <br><br>Daily runs<br>
    <table>
        <tr>
            <th>Code style</th>
            <th>Infection</th>
            <th>PHPUnit</th>
            <th>Rector</th>
            <th>Security</th>
            <th>Static analysis</th>
        </tr>
        <tr>
            <td><img src="https://img.shields.io/github/actions/workflow/status/Guikingone/SchedulerBundle/code-style.yml?branch=main&style=flat" alt="Code style"></td>
            <td><img src="https://img.shields.io/github/actions/workflow/status/Guikingone/SchedulerBundle/infection.yml?branch=main&style=flat" alt="Infection"></td>
            <td><img src="https://img.shields.io/github/actions/workflow/status/Guikingone/SchedulerBundle/phpunit.yml?branch=main&style=flat" alt="PHPUnit"></td>
            <td><img src="https://img.shields.io/github/actions/workflow/status/Guikingone/SchedulerBundle/rector.yml?branch=main&style=flat" alt="Rector"></td>
            <td><img src="https://img.shields.io/github/actions/workflow/status/Guikingone/SchedulerBundle/security.yml?branch=main&style=flat" alt="Security"></td>
            <td><img src="https://img.shields.io/github/actions/workflow/status/Guikingone/SchedulerBundle/static-analysis.yml?branch=main&style=flat" alt="Static analysis"></td>
        </tr>
    </table>
</div>

<h4 align="center">A Symfony bundle built to schedule/consume repetitive tasks</h4>

## Main features

- External transports (Doctrine, Redis, etc)
- External configuration storage (Doctrine, Redis, etc)
- Retry / Remove / Sort policies
- Background worker
- [Symfony/Messenger](https://symfony.com/doc/current/messenger.html) integration
- [Mercure](https://www.mercure.rocks) integration
- [Fibers](https://www.php.net/manual/en/language.fibers.php) support

## Installation

Make sure Composer is installed globally, as explained in the
[installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.

```bash
composer require guikingone/scheduler-bundle
```

## Quick start

If symfony/flex is not installed, manually update the `config/bundles.php`:

```php
// config/bundles.php

return [
    // ...
    SchedulerBundle\SchedulerBundle::class => ['all' => true],
];
```

Then [configure a transport](doc/transport.md) in `config/packages/scheduler.yaml`:

```yaml
# config/packages/scheduler.yaml
scheduler_bundle:
    transport:
        dsn: 'filesystem://first_in_first_out'
```

Finally, it's time to [create a simple task](doc/tasks.md):

```yaml
# config/packages/scheduler.yaml
scheduler_bundle:
    transport:
        dsn: 'filesystem://first_in_first_out'
    tasks:
        foo:
            type: 'command'
            command: 'cache:clear'
            expression: '*/5 * * * *'
            description: 'A simple cache clear task'
            options:
                env: test
```

When a task is configured, time to execute it, two approaches can be used:

- Adding a cron entry `* * * * * cd /path-to-your-project && php bin/console scheduler:consume >> /dev/null 2>&1`
- Launching the command `scheduler:consume --wait` in a background command

## Documentation

* [Usage](doc/usage.md)
* [Configuration](doc/configuration.md)
* [Best practices](doc/best_practices.md)
* [Tasks](doc/tasks.md)
* [Transports](doc/transport.md)
* [Lock](doc/lock.md)
* [Commands](doc/command.md)
* [Events](doc/events.md)
* [Lazy Loading](doc/lazy_loading.md)
* [Messenger](doc/messenger.md)
* [HTTP entrypoint](doc/http.md)
* [ExecutionPolicies](doc/execution_policies.md)
* [SchedulePolicies](doc/schedule_policies.md)
* [Runners](doc/runners.md)
* [Worker](doc/worker.md)
* [Scheduler](doc/scheduler.md)
* [Middleware](doc/middleware.md)
* [Probe](doc/probe.md)
* [Tests](doc/test.md)
* [Mercure](doc/mercure.md)

# Contributing

Want to [improve](.github/CONTRIBUTING.md) this bundle?

SchedulerBundle

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README