Skip to content

docs: add quick start section #32

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

Open
okwn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add quick start section #32

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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,12 @@ agentmail <command> --arg @data://file.txt
## Documentation

[docs.agentmail.to](https://docs.agentmail.to)

## Quick Start

```bash
npm install -g @agentmail/cli
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot May 23, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1: Conflicting npm package name in Quick Start section: @agentmail/cli should be agentmail-cli to match the canonical package name and existing Installation section

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 108:

<comment>Conflicting npm package name in Quick Start section: `@agentmail/cli` should be `agentmail-cli` to match the canonical package name and existing Installation section</comment>

<file context>
@@ -101,3 +101,12 @@ agentmail <command> --arg @data://file.txt
+## Quick Start
+
+```bash
+npm install -g @agentmail/cli
+agentmail init
+agentmail send --to user@example.com --subject "Hello"
</file context>
Suggested change
npm install -g @agentmail/cli
npm install -g agentmail-cli
Fix with Cubic

agentmail init
agentmail send --to user@example.com --subject "Hello"
```