Skip to content

Document Inbox as the project and Inbox Client Protocol #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kzu merged 1 commit into from
Aug 22, 2026
Merged

Document Inbox as the project and Inbox Client Protocol #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Issue tracker

Issues live in GitHub Issues for `devlooped/whatsbox`. See `docs/agents/issue-tracker.md`.
Issues live in GitHub Issues for `devlooped/Inbox`. See `docs/agents/issue-tracker.md`.

### Triage labels

Expand Down
32 changes: 16 additions & 16 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,48 +1,48 @@
# Changelog

## [v0.1.5](https://github.com/devlooped/whatsbox/tree/v0.1.5) (2026-08-20)
## [v0.1.5](https://github.com/devlooped/Inbox/tree/v0.1.5) (2026-08-20)

[Full Changelog](https://github.com/devlooped/whatsbox/compare/v0.1.4...v0.1.5)
[Full Changelog](https://github.com/devlooped/Inbox/compare/v0.1.4...v0.1.5)

:sparkles: Implemented enhancements:

- Subscribe is JID-only; fix directory identity and reply quotes [\#10](https://github.com/devlooped/whatsbox/pull/10) (@kzu)
- Subscribe is JID-only; fix directory identity and reply quotes [\#10](https://github.com/devlooped/Inbox/pull/10) (@kzu)

:twisted_rightwards_arrows: Merged:

- Pack WhatsDemo as the wd tool with pointer and RID packages [\#12](https://github.com/devlooped/whatsbox/pull/12) (@kzu)
- Pack WhatsDemo as the wd tool with pointer and RID packages [\#12](https://github.com/devlooped/Inbox/pull/12) (@kzu)

## [v0.1.4](https://github.com/devlooped/whatsbox/tree/v0.1.4) (2026-08-19)
## [v0.1.4](https://github.com/devlooped/Inbox/tree/v0.1.4) (2026-08-19)

[Full Changelog](https://github.com/devlooped/whatsbox/compare/v0.1.3...v0.1.4)
[Full Changelog](https://github.com/devlooped/Inbox/compare/v0.1.3...v0.1.4)

## [v0.1.3](https://github.com/devlooped/whatsbox/tree/v0.1.3) (2026-08-19)
## [v0.1.3](https://github.com/devlooped/Inbox/tree/v0.1.3) (2026-08-19)

[Full Changelog](https://github.com/devlooped/whatsbox/compare/v0.1.2...v0.1.3)
[Full Changelog](https://github.com/devlooped/Inbox/compare/v0.1.2...v0.1.3)

:bug: Fixed bugs:

- Stop double-emitting the first pairing QR [\#8](https://github.com/devlooped/whatsbox/pull/8) (@kzu)
- Stop double-emitting the first pairing QR [\#8](https://github.com/devlooped/Inbox/pull/8) (@kzu)

## [v0.1.2](https://github.com/devlooped/whatsbox/tree/v0.1.2) (2026-08-19)
## [v0.1.2](https://github.com/devlooped/Inbox/tree/v0.1.2) (2026-08-19)

[Full Changelog](https://github.com/devlooped/whatsbox/compare/v0.1.1...v0.1.2)
[Full Changelog](https://github.com/devlooped/Inbox/compare/v0.1.1...v0.1.2)

:sparkles: Implemented enhancements:

- Allow setting the WhatsApp linked-device name on initialize [\#5](https://github.com/devlooped/whatsbox/pull/5) (@kzu)
- Allow setting the WhatsApp linked-device name on initialize [\#5](https://github.com/devlooped/Inbox/pull/5) (@kzu)

:twisted_rightwards_arrows: Merged:

- Expand markdown includes in package readme [\#7](https://github.com/devlooped/whatsbox/pull/7) (@kzu)
- Expand markdown includes in package readme [\#7](https://github.com/devlooped/Inbox/pull/7) (@kzu)

## [v0.1.1](https://github.com/devlooped/whatsbox/tree/v0.1.1) (2026-08-19)
## [v0.1.1](https://github.com/devlooped/Inbox/tree/v0.1.1) (2026-08-19)

[Full Changelog](https://github.com/devlooped/whatsbox/compare/7f2763626f62021d3a2070b22dde229fd8522363...v0.1.1)
[Full Changelog](https://github.com/devlooped/Inbox/compare/7f2763626f62021d3a2070b22dde229fd8522363...v0.1.1)

:sparkles: Implemented enhancements:

- Create C\# client around the native whatsbox CLI [\#4](https://github.com/devlooped/whatsbox/pull/4) (@kzu)
- Create C\# client around the native whatsbox CLI [\#4](https://github.com/devlooped/Inbox/pull/4) (@kzu)



Expand Down
8 changes: 4 additions & 4 deletions docs/INBOX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Inbox Protocol
# Inbox Client Protocol (ICP)

**Status:** v0.1 (draft, session-locked with WhatsBox)
**Wire version:** `"0.1"`
**Transport:** JSON-RPC 2.0, NDJSON over stdio
**Reference profile:** WhatsApp / [`docs/WHATSBOX.md`](WHATSBOX.md)

Inbox is a **single client-facing JSON-RPC 2.0 pub/sub bus** for local companion processes. One binary owns one messaging-product session and exposes it over stdin/stdout. Clients subscribe to chats and two system topics, send a small set of actions, and receive live events. It is **not** an archive, a search engine, or a product CLI.
Inbox Client Protocol (**ICP**) is a **single client-facing JSON-RPC 2.0 pub/sub bus** for local companion processes. One binary owns one messaging-product session and exposes it over stdin/stdout. Clients subscribe to chats and two system topics, send a small set of actions, and receive live events. It is **not** an archive, a search engine, or a product CLI.

A client implements the methods, events, store/files rules, and error tokens in this document **once**. Product differences appear only as:

Expand Down Expand Up @@ -1425,9 +1425,9 @@ Recommended for new unifying clients. Gateways MUST still ignore unknown `contex

## 23. Relationship to WhatsBox

This document is the **protocol**. [`docs/WHATSBOX.md`](WHATSBOX.md) is the **WhatsApp profile**: store layout, LID canonicalization, HistorySync headers, ContextInfo `remoteJid`, group `MarkRead` participant, and the shipped `whatsbox` binary. It does not restate the method table, event envelope, or error tokens.
This document is **Inbox Client Protocol (ICP)** (also the managed `Inbox` client). [`docs/WHATSBOX.md`](WHATSBOX.md) is the **WhatsApp profile** for the native `whatsbox` adapter in this Inbox repository: store layout, LID canonicalization, HistorySync headers, ContextInfo `remoteJid`, group `MarkRead` participant, and the shipped `whatsbox` binary. The `WhatsBox` NuGet is the managed host on top of that adapter. This spec does not restate the method table, event envelope, or error tokens.

A `whatsbox` binary is a conformant Inbox Protocol implementation when it speaks this envelope (including `product`, `identity`, and `capabilities` on `initialize` / `session.status`) and maps WhatsApp as in WHATSBOX.md + RFC-1.
A `whatsbox` binary is a conformant ICP implementation when it speaks this envelope (including `product`, `identity`, and `capabilities` on `initialize` / `session.status`) and maps WhatsApp as in WHATSBOX.md + RFC-1.

Wire version stays **`"0.1"`** so one codec spans the family.

6 changes: 3 additions & 3 deletions docs/WHATSBOX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# WhatsBox

WhatsBox is **an Inbox Protocol implementation for WhatsApp**.
WhatsBox is the **WhatsApp adapter** for Inbox Client Protocol (ICP): native binary `whatsbox`, managed NuGet `WhatsBox`.

**Status:** v0.1 (session-locked)
**License (product):** MIT
**Language:** Go
**Library:** [whatsmeow](https://github.com/tulir/whatsmeow)

whatsbox is the **WhatsApp implementation** of [Inbox Protocol](INBOX.md): a local linked-device companion that owns one WhatsApp session and exposes it as a JSON-RPC 2.0 pub/sub bus over stdio.
`whatsbox` is the native WhatsApp adapter in this Inbox repository: a local linked-device companion that owns one WhatsApp session and exposes it as a JSON-RPC 2.0 pub/sub bus over stdio. The `WhatsBox` NuGet is the managed host on top of that adapter.

Wire, methods, events, files, errors, client-once rules, and capabilities are specified in **INBOX.md**. This document is the WhatsApp profile: how that envelope maps onto WhatsApp Web (LIDs, QR pairing, ContextInfo, HistorySync headers, store layout). It does **not** restate the method table.

`external/whatsmeow` and `external/wacli` in this workspace are **reference only**; whatsbox is a greenfield repo and does not share databases, packages, or command surface with wacli.
`external/whatsmeow` and `external/wacli` in this workspace are **reference only**; the adapter does not share databases, packages, or command surface with wacli.

---

Expand Down
2 changes: 1 addition & 1 deletion osmfeula.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ End User License Agreement

This Open Source Maintenance Fee Agreement ("Agreement") is a legal agreement
between you ("User") and Devlooped ("Project") for the use of
whatsbox ("Software"), an open source software project licensed under
Inbox ("Software"), an open source software project licensed under
the MIT License ("OSI License"), an OSI-approved open source license.
Project offers a Binary Release of the Software to Users in exchange for a
maintenance fee ("Fee"). "Binary Release" refers to pre-compiled executable
Expand Down
Loading
Loading