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

{% block docs_content %}
  <div class="mb-4">
    <h1 class="h3 mb-1">list-timers</h1>
    <p class="text-muted mb-0">List timers in your user scope, a team you own, or a repo you can read.</p>
  </div>

  <div class="alert alert-info mb-4" role="note">
    New to deferred work? Read the <a href="/docs/guides/timers">Timers and future signals guide</a>
    or follow <a href="/docs/guides/scheduled-maintenance">recurring repository maintenance</a>.
  </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 list-timers [--team &lt;slug&gt;] [--repo &lt;locator&gt;] [--status &lt;status&gt;]</code></pre>
      </div>
      <p class="text-muted mt-2 mb-0">Omit <code>--team</code> and <code>--repo</code> for your own timers. The two scope flags conflict.</p>
    </div>
  </div>

  <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 list-timers
pearing-cli list-timers --team platform
pearing-cli list-timers --repo teams/platform/website --status active</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 API page JSON. <code>status</code> accepts <code>active</code>, <code>paused</code>, <code>completed</code>, or <code>cancelled</code>.</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>Invalid status values return a validation error.</li>
        <li>Team timers require team ownership; repo timers require repo read 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>List timers.

Timers are scoped to you, a team you own, or a repo you can read.

Examples:

  list-timers
  list-timers --team platform
  list-timers --repo teams/platform/website --status active

Usage: pearing-cli list-timers [OPTIONS]

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;
          Filter by status

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