Skip to content

Commit a7cfcae

Browse files
Rename claude-code/ to skills/ and add Homebrew caveats
- Rename SKILL.md to skills/fastmail.md - Update goreleaser to install skill file to share/fm/ - Add post-install caveats showing symlink command for Claude Code - Update README with correct paths for both Homebrew and manual install - Document --json fields syntax and additional search operators in skill
1 parent 0346514 commit a7cfcae

File tree

3 files changed

+31
-5
lines changed

3 files changed

+31
-5
lines changed

.goreleaser.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ archives:
3535
files:
3636
- LICENSE*
3737
- README*
38+
- skills/fastmail.md
3839

3940
checksum:
4041
name_template: "checksums.txt"
@@ -57,5 +58,10 @@ brews:
5758
license: MIT
5859
install: |
5960
bin.install "fm"
61+
(share/"fm").install "skills/fastmail.md"
6062
test: |
6163
system "#{bin}/fm", "version"
64+
caveats: |
65+
To use fm with Claude Code, create a symlink to the skill file:
66+
mkdir -p ~/.claude/commands
67+
ln -sf #{share}/fm/fastmail.md ~/.claude/commands/fastmail.md

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,19 +138,26 @@ Example JSON output:
138138

139139
## Claude Code Integration
140140

141-
If you use [Claude Code](https://docs.anthropic.com/en/docs/claude-code), you can add the included skill to let Claude manage your email:
141+
If you use [Claude Code](https://docs.anthropic.com/en/docs/claude-code), you can add the included skill to let Claude manage your email.
142142

143+
**If installed via Homebrew:**
143144
```bash
144-
mkdir -p ~/.claude/skills
145-
cp claude-code/SKILL.md ~/.claude/skills/fastmail.md
145+
mkdir -p ~/.claude/commands
146+
ln -sf $(brew --prefix)/share/fm/fastmail.md ~/.claude/commands/fastmail.md
147+
```
148+
149+
**If installed manually:**
150+
```bash
151+
mkdir -p ~/.claude/commands
152+
ln -sf /path/to/fastmail-cli/skills/fastmail.md ~/.claude/commands/fastmail.md
146153
```
147154

148155
Then ask Claude things like:
149156
- "Check my inbox for unread emails"
150157
- "Search for emails from Alice about the project"
151158
- "Draft a reply to the last email from Bob"
152159

153-
See [claude-code/SKILL.md](claude-code/SKILL.md) for the full command reference.
160+
See [skills/fastmail.md](skills/fastmail.md) for the full command reference.
154161

155162
## Authentication
156163

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,20 +42,33 @@ What would you like to do?
4242
```bash
4343
# List recent inbox emails
4444
fm inbox
45+
fm inbox --limit 10
46+
47+
# JSON output with specific fields
48+
fm inbox --json id,subject,from
4549

4650
# Search emails (returns up to 50 by default)
4751
fm search "query"
4852
fm search "query" --limit 100
4953
fm search "query" --folder inbox
50-
fm search "query" --json
54+
55+
# Search with JSON output
56+
fm search "query" --json id,subject,from,date
5157
```
5258

59+
**Available JSON fields:** `id`, `threadId`, `subject`, `from`, `to`, `cc`, `date`, `preview`, `unread`, `attachment`
60+
5361
**Search operators:**
5462
- `from:alice` - Emails from alice
5563
- `to:bob` - Emails to bob
5664
- `subject:hello` - Subject contains hello
5765
- `has:attachment` - Has attachments
5866
- `is:unread` - Unread emails only
67+
- `is:flagged` - Flagged/starred emails
68+
- `before:YYYY-MM-DD` - Emails before date
69+
- `after:YYYY-MM-DD` - Emails after date
70+
71+
**Boolean operators:** `AND`, `OR`, `NOT`, `()` for grouping
5972

6073
### Reading Emails
6174

0 commit comments

Comments
 (0)