{% extends "docs/base.html" %}

{% block docs_content %}
  <div class="mb-4">
    <h1 class="h3 mb-1">create-timer</h1>
    <p class="text-muted mb-0">Create a one-off or recurring timer that emits an event carrying its message.</p>
  </div>

  {% include "docs/partials/timer-access.html" %}

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Usage</h2>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>pearing-cli create-timer [&lt;message&gt;] [schedule flags] [--status &lt;status&gt;] [--team &lt;slug&gt; | --repo &lt;locator&gt;]</code></pre>
      </div>
      <p class="text-muted mt-2 mb-0">Pass the message positionally, or omit it to read from stdin. Omit <code>--team</code> and <code>--repo</code> for your own timers. Initial status is <code>active</code> by default and may be set to <code>paused</code>.</p>
    </div>
  </div>

  {% include "docs/partials/timer-schedule-fields.html" %}

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Examples</h2>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>pearing-cli create-timer "Check the deployment" --run-in 5m

pearing-cli create-timer \
  "Review the release checklist" \
  --time-of-day 09:00 \
  --days-of-week Mon,Tue,Wed,Thu,Fri \
  --timezone America/New_York \
  --team platform

pearing-cli create-timer \
  "Poll the build" \
  --every-seconds 300 \
  --repo teams/platform/website</code></pre>
      </div>
    </div>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Response</h2>
      <p class="mb-0">Prints the created timer JSON, including its UUID, normalized schedule, status, and next run time.</p>
    </div>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Errors</h2>
      <ul class="mb-0">
        <li>Exactly one schedule form is required.</li>
        <li><code>run_at</code> must be in the future, and calendar schedules require a valid time and IANA timezone.</li>
        <li>Team timers require team ownership; repo timers require maintainer access.</li>
      </ul>
    </div>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Help Output</h2>
      <div class="bg-light border rounded p-3">
        <pre class="mb-0"><code>Create a timer.

A timer emits an event carrying its message. Use --run-in or --run-at
for a one-off, or --every-seconds or --time-of-day to repeat.
The message defaults to stdin when omitted.

Examples:

  create-timer "stand up" --run-in 5m
  create-timer "daily standup" --time-of-day 09:00 --days-of-week Mon,Tue,Wed,Thu,Fri
  echo "piped message" | create-timer --run-in 1h

Usage: pearing-cli create-timer [OPTIONS] [MESSAGE]

Arguments:
  [MESSAGE]
          Message delivered with the event. Defaults to stdin when omitted

Options:
      --team &lt;TEAM&gt;
          Address a team's timers. Requires team ownership

      --repo &lt;REPO&gt;
          Address a repo's timers. Read access is enough to list or fetch; create, update, and delete require maintainer access

      --run-in &lt;RUN_IN&gt;
          Fire once after this duration, for example 5m or 2h

      --run-at &lt;RUN_AT&gt;
          Fire once at this RFC 3339 instant

      --every-seconds &lt;EVERY_SECONDS&gt;
          Repeat on a fixed period in seconds

      --time-of-day &lt;TIME_OF_DAY&gt;
          Repeat at this local time of day, as HH:MM. Requires --days-of-week

      --days-of-week &lt;DAYS_OF_WEEK&gt;
          Days to repeat on: Sun, Mon, Tue, Wed, Thu, Fri, Sat, or all

      --timezone &lt;TIMEZONE&gt;
          IANA timezone the time of day is evaluated in. Defaults to UTC

      --status &lt;STATUS&gt;
          Initial status: active or paused

  -h, --help
          Print help (see a summary with '-h')</code></pre>
      </div>
    </div>
  </div>
{% endblock %}