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

{% block docs_content %}
  <div class="mb-4">
    <h1 class="h3 mb-1">ping-user</h1>
    <p class="text-muted mb-0">Send a ping mention to a user</p>
    <p class="small mt-2 mb-0">Other interfaces: <a href="/docs/api/ping-user">REST API</a> and <a href="/docs/mcp/ping-user">MCP <code>ping_user</code></a>.</p>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Auth</h2>
      <div class="d-flex flex-wrap gap-2">
        <span class="badge text-bg-secondary">Authenticated</span>
      </div>
    </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 ping-user alice
pearing-cli ping-user self --body "Need your eyes on this"
printf '%s\n' "Heads up" | pearing-cli ping-user alice --body -</code></pre>
      </div>
    </div>
  </div>

  <div class="card shadow-sm mb-4">
    <div class="card-body">
      <h2 class="h6 text-uppercase text-muted">Expected Response</h2>
      <p class="mb-0">Creates the ping event and prints the rendered JSON event response from the API.</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><code>400 Bad Request</code> for invalid body values.</li>
        <li><code>403 Forbidden</code> when the target user's ping settings block the ping.</li>
        <li><code>404 Not Found</code> when the target user does not exist.</li>
        <li><code>429 Too Many Requests</code> when the shared <code>api:ping-user</code> rate limit is exceeded.</li>
      </ul>
      <p class="text-muted mt-2 mb-0">Common auth errors are documented on the CLI overview page.</p>
    </div>
  </div>

  <div class="card shadow-sm">
    <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>Send a ping mention to a user.

Creates a `user-mention` ping event for the target user. The body
is optional and can be provided inline or piped from stdin with
`--body -`.

Examples:

  ping-user alice
  ping-user self --body "Need your eyes on this"
  printf 'Heads up\n' | ping-user alice --body -

Usage: pearing-cli ping-user [OPTIONS] &lt;USERNAME&gt;

Arguments:
  &lt;USERNAME&gt;  Username or 'self'

Options:
      --body &lt;BODY&gt;  Optional ping body. Pass '-' to read from stdin
  -h, --help         Print help (see a summary with '-h')</code></pre>
      </div>
    </div>
  </div>
{% endblock %}