• Schedule artisan commands to run automatically
• Scheduling is maintained within your version control system
• Single source of truth for when and where commands run
• Schedule commands to run with arguments and options
• Run commands as other users
• Run commands in certain environments
• Use custom drivers for custom scheduling contexts

scheduled
  scheduled:make              Create a new scheduled artisan command
  scheduled:run               Run scheduled commands
  scheduled:summary           View a summary of all scheduled artisan commands

<ol dir="auto">
  <li>
    Add use statements to your command. If you&#8217;re using a custom driver you will use a different <code>Scheduler</code> class.
  </li>
</ol>

<pre>use IndatusDispatcherSchedulingScheduledCommand;

use IndatusDispatcherSchedulingSchedulable; use IndatusDispatcherDriversDateTimeScheduler;

<ol start="2" dir="auto">
  <li>
    Extend <code>IndatusDispatcherSchedulingScheduledCommand</code>
  </li>
  <li>
    Implement schedule():
  </li>
</ol>

<pre>	/**
 * When a command should run
 *
 * @param Scheduler $scheduler
 *
 * @return Scheduler
 */
public function schedule(Schedulable $scheduler)
{
	return $scheduler;
}</pre>

<p>
  </a>For details and examples on how to schedule, see the <a rel="nofollow noopener" target="_blank" href="#datetime">DateTime Driver</a>.<br /> <a rel="nofollow noopener" target="_blank" name="user-content-commands-as-users"><br /> ### Running Commands As Users<br /> You may override <code>user()</code> to run a given artisan command as a specific user. Ensure your <code>scheduled:run</code> artisan command is running as root.</p> 
  
  <pre>    public function user()
{
    return 'backup';
}</pre>
  
  <blockquote>
    <p>
      This feature may not be supported by all drivers.
    </p>
  </blockquote>
  
  <p>
    </a><a rel="nofollow noopener" target="_blank" name="user-content-environment-commands"><br /> ### Environment-Specific Commands<br /> You may override <code>environment()</code> to ensure your command is only scheduled in specific environments. It should provide a single environment or an array of environments.</p> 
    
    <pre>    public function environment()
{
    return ['development','staging'];
}</pre>
    
    <p>
      </a><a rel="nofollow noopener" target="_blank" name="user-content-maintenance-mode"><br /> ### Maintenance Mode<br /> By default, cron commands will not run when application is in Maintenance Mode. This will prevent all sorts of weird output that might occur if a cron command is run while you are migrating a database or doing a composer update.<br /> You may override <code>runInMaintenanceMode()</code> to force your command to still be run while the application is in maintenance mode.</p> 
      
      <pre>    public function runInMaintenanceMode()
{
    return true;
}</pre>
      
      <p>
        </a><a rel="nofollow noopener" target="_blank" name="user-content-advanced-scheduling"><br /> ### Advanced scheduling<br /> You may schedule a given command to to run at multiple times by <code>schedule()</code> returning multiple <code>Schedulable</code> instances.</p> 
        
        <pre>	public function schedule(Schedulable $scheduler)
{
    return [
        // 5am Mon-Fri
        $scheduler-&gt;everyWeekday()-&gt;hours(5),

        // 2am every Saturday
        App::make(get_class($scheduler))
            -&gt;daysOfTheWeek(Scheduler::SATURDAY)
            -&gt;hours(2)
    ];
}</pre>
        
        <p>
          You may also schedule a command to run with arguments and options.
        </p>
        
        <pre>	public function schedule(Schedulable $scheduler)
{
	return [
        // equivalent to: php /path/to/artisan command:name /path/to/file
        $scheduler-&gt;args(['/path/to/file'])
            -&gt;everyWeekday()
            -&gt;hours(5),

        // equivalent to: php /path/to/artisan command:name /path/to/file --force --toDelete="expired" --exclude="admins" --exclude="developers"
        $scheduler-&gt;args(['/path/to/file'])
            -&gt;opts([
                'force',
                'toDelete' =&gt; 'expired',
                'exclude' =&gt; [
                    'admins',
                    'developers'
                ]
            ])
            -&gt;daysOfTheMonth([1, 15])
            -&gt;hours(2)
    ];
}</pre>
        
        <blockquote>
          <p>
            NOTE: Both <code>args()</code> and <code>opts()</code>, whichever is called first, will internally create a new <code>Schedulable</code> instance for you so you don&#8217;t need to <code>App::make()</code>.
          </p>
        </blockquote>
        
        <p>
          </a><a rel="nofollow noopener" target="_blank" name="user-content-drivers"><br /> ## Drivers<br /> </a>Drivers provide the ability to add additional context to your scheduling. <a rel="nofollow noopener" target="_blank" href="#custom-drivers">Building custom drivers</a> is a great way to customize this context to your application&#8217;s needs.<br /> <a rel="nofollow noopener" target="_blank" name="user-content-datetime"><br /> ### DateTime (Default)<br /> Examples of how to schedule:</p> 
          
          <pre>	public function schedule(Schedulable $scheduler)
{
    //every day at 4:17am
    return $scheduler-&gt;daily()-&gt;hours(4)-&gt;minutes(17);
}</pre>
          
          <pre>	public function schedule(Schedulable $scheduler)
{
    //every Tuesday/Thursday at 5:03am
    return $scheduler-&gt;daysOfTheWeek([
            Scheduler::TUESDAY,
            Scheduler::THURSDAY
        ])-&gt;hours(5)-&gt;minutes(3);
}</pre>
          
          <pre>	public function schedule(Schedulable $scheduler)
{
    //the second and third Tuesday of every month at 12am
    return $scheduler-&gt;monthly()-&gt;week([2, 3])-&gt;daysOfTheWeek(Day::TUESDAY);
}</pre>
          
          <p>
            </a><a rel="nofollow noopener" target="_blank" name="user-content-custom-drivers"><br /> ## Custom Drivers<br /> Custom drivers allow you to provide application context within scheduling. For example, an education-based application may contain scheduling methods like <code>inServiceDays()</code>, <code>springBreak()</code> and <code>christmasBreak()</code> where commands are run or don&#8217;t run during those times.<br /> Create a packagepath such as <code>MyAppScheduleDriver</code> and create two classes:</p> 
            
            <ul dir="auto">
              <li>
                <code>Scheduler</code> that <code>implements IndatusDispatcherSchedulingSchedulable</code>. This class should provide a useful interface for programmers to schedule their commands.
              </li>
              <li>
                <code>ScheduleService</code> that <code>extends IndatusDispatcherServicesScheduleService</code>. This class contains logic on how to determine if a command is due to&#8230;</a></p>