Auth
Authenticated
Examples
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 -
Expected Response
Creates the ping event and prints the rendered JSON event response from the API.
Errors
400 Bad Requestfor invalid body values.403 Forbiddenwhen the target user's ping settings block the ping.404 Not Foundwhen the target user does not exist.429 Too Many Requestswhen the sharedapi:ping-userrate limit is exceeded.
Common auth errors are documented on the CLI overview page.
Help Output
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] <USERNAME>
Arguments:
<USERNAME> Username or 'self'
Options:
--body <BODY> Optional ping body. Pass '-' to read from stdin
-h, --help Print help (see a summary with '-h')