fix: remove dead CONTRIBUTING.md link, expand auth docs#54
Conversation
- Contributing section: inline dev setup instead of linking nonexistent file - Auth Setup: explain the SMS flow (auto-retrieve via imsg on macOS, manual fallback) - Credentials stored at ~/.config/partiful/auth.json
📝 WalkthroughWalkthroughDocumentation update to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
183-189: Consider documenting the environment variable overrides.While the documented flow is accurate, the code supports two additional authentication methods that advanced users might find useful:
PARTIFUL_CREDENTIALS_FILE— override the default credentials pathPARTIFUL_TOKEN— provide an access token directly, bypassing file-based authThese are currently not mentioned in the README. As per context snippet 1 (src/lib/auth.js:12-37),
loadConfig()andresolveCredentialsPath()support these env vars.📝 Optional addition to document env var overrides
Add after line 188:
5. Credentials are saved to `~/.config/partiful/auth.json` + +**Advanced:** Set `PARTIFUL_CREDENTIALS_FILE` to use a custom credentials path, or `PARTIFUL_TOKEN` to bypass file-based auth entirely.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 183 - 189, Update the README near the authentication flow to document the two env var overrides supported by the code: mention PARTIFUL_CREDENTIALS_FILE (overrides the default credentials path used by resolveCredentialsPath()/loadConfig()) and PARTIFUL_TOKEN (directly provides an access token to bypass file-based auth), and clarify their precedence/behavior (i.e., PARTIFUL_TOKEN bypasses file loading, PARTIFUL_CREDENTIALS_FILE points loadConfig() to an alternate path).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 186: Update the imsg repository URL in the README entry that currently
links to https://github.com/nicktomlin/imsg; change the link target for the
"imsg" reference to the correct repository URL https://github.com/steipete/imsg
so the README points to the proper CLI tool source.
---
Nitpick comments:
In `@README.md`:
- Around line 183-189: Update the README near the authentication flow to
document the two env var overrides supported by the code: mention
PARTIFUL_CREDENTIALS_FILE (overrides the default credentials path used by
resolveCredentialsPath()/loadConfig()) and PARTIFUL_TOKEN (directly provides an
access token to bypass file-based auth), and clarify their precedence/behavior
(i.e., PARTIFUL_TOKEN bypasses file loading, PARTIFUL_CREDENTIALS_FILE points
loadConfig() to an alternate path).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| **How it works:** | ||
| 1. You provide your phone number (E.164 format, e.g. `+12065551234`) | ||
| 2. Partiful sends an SMS verification code to that number | ||
| 3. On macOS with [`imsg`](https://github.com/nicktomlin/imsg) installed, the code is auto-retrieved from Messages |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
What is the correct GitHub repository URL for the imsg command-line tool for macOS Messages?
💡 Result:
The correct GitHub repository URL for the imsg command-line tool for macOS Messages is https://github.com/steipete/imsg.
Citations:
- 1: https://github.com/steipete/imsg
- 2: https://imsg.to/
- 3: https://github.com/steipete/imsg/blob/main/AGENTS.md
- 4: https://clawbot.ai/ecosystem/imsg.html
Update the imsg repository URL in line 186.
The linked repository is incorrect. The imsg CLI tool is located at https://github.com/steipete/imsg, not https://github.com/nicktomlin/imsg.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 186, Update the imsg repository URL in the README entry
that currently links to https://github.com/nicktomlin/imsg; change the link
target for the "imsg" reference to the correct repository URL
https://github.com/steipete/imsg so the README points to the proper CLI tool
source.
CONTRIBUTING.mdlink with inline dev setup instructionsimsgon macOS, manual fallback on other platforms, creds stored at~/.config/partiful/auth.jsonSummary by CodeRabbit