Skip to content

docs: add quick start section#32

Open
okwn wants to merge 1 commit into
agentmail-to:mainfrom
okwn:docs/add-quickstart
Open

docs: add quick start section#32
okwn wants to merge 1 commit into
agentmail-to:mainfrom
okwn:docs/add-quickstart

Conversation

@okwn
Copy link
Copy Markdown

@okwn okwn commented May 23, 2026

Summary by cubic

Adds a Quick Start to the README so users can install @agentmail/cli and send their first email fast. Includes a 3-step snippet: npm install -g @agentmail/cli, agentmail init, and agentmail send --to user@example.com --subject "Hello".

Written for commit e5ea0ab. Summary will update on new commits. Review in cubic

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

1 issue found across 1 file

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="README.md">

<violation number="1" location="README.md:108">
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</violation>
</file>

Reply with feedback, questions, or to request a fix.

Fix all with cubic | Re-trigger cubic

Comment thread README.md
## Quick Start

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

@cubic-dev-ai cubic-dev-ai Bot May 23, 2026

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant