docs: clarify MailCLI project overview - #9
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This refreshes the README opening so new visitors can understand MailCLI before they get to installation details.
It now leads with the product boundary: MailCLI is a local-first, provider-neutral email interface for AI agents that works over existing mailboxes. The opening also makes the non-goals explicit: it is not a hosted agent mailbox, not a human mail client replacement, and not a default permission grant for agents to mutate mailboxes.
The zero-network onboarding sections were consolidated into one 2-minute local flow, and the later quick-start area was renamed to a command cookbook so the README no longer repeats the same first-run path several times.
Verification
go build -o mailcli ./cmd/mailcli./mailcli parse --format json testdata/emails/invoice.eml./mailcli triage message testdata/emails/invoice.eml./mailcli sync --config examples/config/fixtures-dir.yaml --account fixtures --index /tmp/mailcli-fixtures-index.db --limit 0./mailcli threads --index /tmp/mailcli-fixtures-index.db invoicemake demo-local-thread-checkgit diff --checkgo test ./...Post-Deploy Monitoring & Validation
No additional operational monitoring required - documentation-only change with no runtime, packaging, or release behavior impact.
🤖 Generated with GPT-5 via Codex