@pidgeon-ai/cli 1.7.0 → 1.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -10
- package/package.json +12 -4
package/README.md
CHANGED
|
@@ -1,17 +1,52 @@
|
|
|
1
1
|
# `@pidgeon-ai/cli`
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Email inboxes for AI agents, from a terminal. Pidgeon is the email inbox API
|
|
4
|
+
for AI agents. It gives agents their own inboxes so they can work with emails
|
|
5
|
+
just like a human. This is every endpoint as a command, so an agent with a
|
|
6
|
+
shell, or you, can create an address, send, receive and reply.
|
|
4
7
|
|
|
5
8
|
```sh
|
|
6
9
|
npm install -g @pidgeon-ai/cli
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Or run it without installing: `npx -y @pidgeon-ai/cli --help`.
|
|
13
|
+
|
|
14
|
+
## Get a key
|
|
15
|
+
|
|
16
|
+
Every command reads a `pgn_live_…` key from `PIDGEON_API_KEY`. Make one at
|
|
17
|
+
[pidgeon.ai/app/developers/keys](https://pidgeon.ai/app/developers/keys), or
|
|
18
|
+
let your agent sign itself up: [pidgeon.ai/skill.md](https://pidgeon.ai/skill.md)
|
|
19
|
+
is two calls, and the only thing it needs from a person is a six-digit code.
|
|
20
|
+
|
|
21
|
+
```sh
|
|
7
22
|
export PIDGEON_API_KEY=pgn_live_…
|
|
23
|
+
```
|
|
8
24
|
|
|
9
|
-
|
|
10
|
-
|
|
25
|
+
## Create an address, send, receive, reply
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
pidgeon identities create --address scout@pidgeon.email --type agent
|
|
29
|
+
pidgeon messages send --from scout@pidgeon.email --to ops@example.com \
|
|
30
|
+
--subject "Staging access" --text "Could you send me the access code?"
|
|
31
|
+
pidgeon messages await --identity_id <id> --timeout 60
|
|
32
|
+
pidgeon messages reply --id <message id> --text "Thanks, that worked."
|
|
11
33
|
```
|
|
12
34
|
|
|
35
|
+
Any free name on `pidgeon.email` works with no DNS. `messages await` holds
|
|
36
|
+
one request open until mail arrives, and prints it with `extracted.codes` and
|
|
37
|
+
`extracted.links` already pulled out.
|
|
38
|
+
|
|
13
39
|
`pidgeon --help` lists every group; `pidgeon <group> <command> --help`
|
|
14
|
-
describes one command, with its endpoint and its flags.
|
|
40
|
+
describes one command, with its endpoint and its flags. Documentation:
|
|
41
|
+
[pidgeon.ai/docs/cli](https://pidgeon.ai/docs/cli).
|
|
42
|
+
|
|
43
|
+
## Flags
|
|
44
|
+
|
|
45
|
+
- Repeat a list flag: `--to one@example.com --to two@example.com`.
|
|
46
|
+
- `--flag value` and `--flag=value` both work, and a subject may contain
|
|
47
|
+
an `=`.
|
|
48
|
+
- A nested object takes JSON: `--some_field '{"a":1}'`.
|
|
49
|
+
- `PIDGEON_BASE_URL` points it somewhere other than production.
|
|
15
50
|
|
|
16
51
|
## It is generated
|
|
17
52
|
|
|
@@ -26,10 +61,13 @@ so, and the day an endpoint gains a field this gains a flag. The same
|
|
|
26
61
|
document produces the TypeScript client this calls through, the Python
|
|
27
62
|
client, and the MCP server's tool list.
|
|
28
63
|
|
|
29
|
-
##
|
|
64
|
+
## Contributing
|
|
30
65
|
|
|
31
|
-
|
|
32
|
-
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
66
|
+
This package is published from
|
|
67
|
+
[pidgeon-ai/pidgeon-js](https://github.com/pidgeon-ai/pidgeon-js), which is
|
|
68
|
+
copied from Pidgeon's main repository on every release, so a pull request
|
|
69
|
+
there cannot be merged as written.
|
|
70
|
+
[Open an issue](https://github.com/pidgeon-ai/pidgeon-js/issues) and say what
|
|
71
|
+
is wrong, or email [support@pidgeon.ai](mailto:support@pidgeon.ai).
|
|
72
|
+
|
|
73
|
+
MIT licensed.
|
package/package.json
CHANGED
|
@@ -1,10 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pidgeon-ai/cli",
|
|
3
|
-
"version": "1.7.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.7.1",
|
|
4
|
+
"description": "Email inboxes for AI agents, from a terminal — the Pidgeon CLI: create addresses, send, receive and reply.",
|
|
5
5
|
"keywords": [
|
|
6
|
-
"pidgeon",
|
|
7
6
|
"email",
|
|
7
|
+
"email-api",
|
|
8
|
+
"inbox",
|
|
9
|
+
"ai-agents",
|
|
10
|
+
"agent",
|
|
11
|
+
"llm",
|
|
12
|
+
"mcp",
|
|
13
|
+
"otp",
|
|
14
|
+
"verification-code",
|
|
15
|
+
"pidgeon",
|
|
8
16
|
"cli",
|
|
9
17
|
"api-client",
|
|
10
18
|
"agents"
|
|
@@ -46,7 +54,7 @@
|
|
|
46
54
|
"access": "public"
|
|
47
55
|
},
|
|
48
56
|
"dependencies": {
|
|
49
|
-
"@pidgeon-ai/sdk": "1.14.
|
|
57
|
+
"@pidgeon-ai/sdk": "1.14.1"
|
|
50
58
|
},
|
|
51
59
|
"devDependencies": {
|
|
52
60
|
"tsup": "^8.5.0",
|