Skip to content

fix: remove dead CONTRIBUTING.md link, expand auth docs #54

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

Merged
KalebCole merged 1 commit into from
Mar 30, 2026
Merged

fix: remove dead CONTRIBUTING.md link, expand auth docs #54

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
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,13 @@ partiful auth login +12065551234 # sends SMS code, completes auth
partiful auth status # verify you're logged in
```

**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
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Mar 30, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 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:

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.

4. Otherwise, you'll be prompted to enter it manually
5. Credentials are saved to `~/.config/partiful/auth.json`

Tokens auto-refresh when expired. Run `partiful doctor` if anything seems off.

## JSON Output
Expand All @@ -200,7 +207,12 @@ Exit codes: `0` success · `1` API error · `2` auth error · `3` validation ·

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
```bash
git clone https://github.com/KalebCole/partiful-cli && cd partiful-cli
npm install
npm link # makes `partiful` available globally for testing
npm test # run tests
```

## License

Expand Down