docs: add quick start section#32
Open
okwn wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
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
| ## Quick Start | ||
|
|
||
| ```bash | ||
| npm install -g @agentmail/cli |
There was a problem hiding this comment.
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 |
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
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 by cubic
Adds a Quick Start to the README so users can install
@agentmail/cliand send their first email fast. Includes a 3-step snippet:npm install -g @agentmail/cli,agentmail init, andagentmail send --to user@example.com --subject "Hello".Written for commit e5ea0ab. Summary will update on new commits. Review in cubic