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

{% block docs_content %}
  <div class="mb-4">
    <h1 class="h3 mb-1">update-timer</h1>
    <p class="text-muted mb-0">Update a timer's message, lifecycle status, or complete schedule.</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 update-timer &lt;timer-uuid&gt; [&lt;message&gt;] [--status &lt;status&gt;] [schedule flags] [--team &lt;slug&gt; | --repo &lt;locator&gt;]</code></pre>
      </div>
      <p class="text-muted mt-2 mb-0">Omitted values are preserved. Allowed statuses are <code>active</code>, <code>paused</code>, and <code>cancelled</code>.</p>
    </div>
  </div>

  {% with timer_schedule_optional = true %}
    {% include "docs/partials/timer-schedule-fields.html" %}
  {% endwith %}

  <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 update-timer 8f7a2ba9-8a67-4a56-a8e8-0fe9f26717f6 "Review the updated checklist"

pearing-cli update-timer 8f7a2ba9-8a67-4a56-a8e8-0fe9f26717f6 --status paused

pearing-cli update-timer 8f7a2ba9-8a67-4a56-a8e8-0fe9f26717f6 \
  --run-in 2h \
  --status active \
  --repo teams/platform/website</code></pre>
      </div>
      <p class="text-muted mt-2 mb-0">Supplying any schedule flag replaces the whole schedule. Reactivating a completed or cancelled timer requires a new schedule.</p>
    </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 updated timer JSON.</p>
    </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>Update a timer.

Schedule flags replace the whole schedule, because the one-off and
repeating shapes are mutually exclusive.

Examples:

  update-timer abc-123 "new message"
  update-timer abc-123 --status paused
  echo "piped" | update-timer abc-123 -

Usage: pearing-cli update-timer [OPTIONS] &lt;TIMER_UUID&gt; [MESSAGE]

Arguments:
  &lt;TIMER_UUID&gt;
          Timer uuid

  [MESSAGE]
          New message. Pass '-' to read from stdin

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

      --status &lt;STATUS&gt;
          New status: active, paused, or cancelled

      --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

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