Metadata-Version: 2.4
Name: ffyi
Version: 0.3.0
Summary: CLI for friends.fyi
Author: Wilhelm Klopp
License-Expression: MIT
Project-URL: Homepage, https://friends.fyi
Project-URL: Repository, https://github.com/wilhelmklopp/fyi-cli
Keywords: friends-fyi,cli,api-client,agent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx>=0.27.0
Requires-Dist: typer>=0.12.0
Provides-Extra: dev
Requires-Dist: pytest>=8.3.0; extra == "dev"
Dynamic: license-file

# ffyi

CLI for [friends.fyi](https://friends.fyi).

## Install

```bash
uv tool install ffyi
```

Installed commands: `ffyi` and `fyi` (alias).

## Get a token

```bash
fyi login
```

Verifies GitHub ownership via a one-time gist. Creates a new account on
first run; issues a fresh token for returning users. The command shells out to
[`gh`](https://cli.github.com/) to create the verification gist and delete it
after — fully non-interactive, no copying URLs around. Your username is taken
from the gist owner. The returned API key is saved to `~/.config/fyi/token`.

If you already have a token, store it directly:

```bash
fyi auth <token>
fyi whoami
```

## Send

```bash
fyi send alice "hello"
echo '{"status":"ok"}' | fyi send alice --sender "Deploy Bot"
fyi send alice '{"status":"ok"}' --type alert -H "X-Env: prod"
```

## Inbox

```bash
fyi inbox
fyi inbox --sender "Deploy Bot" --user-agent fyi-cli --type alert
fyi inbox <message-id>           # read a single message
fyi inbox --json
```
