rss-skill-cli 0.1.3 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rss-skill-cli",
3
- "version": "0.1.3",
3
+ "version": "0.1.5",
4
4
  "description": "RSS skill pack for AI coding assistants (Claude Code, Cursor, Cline, etc.)",
5
5
  "keywords": [
6
6
  "rss",
package/src/templates.js CHANGED
@@ -56,11 +56,13 @@ scripts/rss-find sync
56
56
  name: rss-feed
57
57
  description: Manage RSS subscriptions and articles for AI agent workflows. Subscribe to feeds, list unread articles, and read/archive content. Use when managing RSS subscriptions or processing feed content.
58
58
  license: MIT
59
+ storage: filesystem (YAML + markdown, no database required)
59
60
  ---
60
61
 
61
62
  # rss-feed
62
63
 
63
64
  Manage RSS subscriptions and articles. Designed for AI agent workflows.
65
+ All data is stored in the filesystem: \`feeds.yaml\` for configuration, markdown files for articles.
64
66
 
65
67
  ## Available scripts
66
68
 
@@ -68,13 +70,22 @@ Manage RSS subscriptions and articles. Designed for AI agent workflows.
68
70
 
69
71
  ## Commands
70
72
 
71
- ### init
72
- Initialize feeds.yaml with default configuration.
73
+ ### init (REQUIRED FIRST)
74
+ Initialize feeds.yaml with sync configuration. **MUST specify --interval and --concurrency**.
73
75
 
74
76
  \`\`\`bash
75
77
  scripts/rss-feed init --interval 30m --concurrency 5
78
+ scripts/rss-feed init --interval 1h --concurrency 10 --on-startup=true
76
79
  \`\`\`
77
80
 
81
+ **Required flags:**
82
+ - \`--interval\`: Sync interval (e.g., '15m', '30m', '1h', '2h30m')
83
+ - \`--concurrency\`: Number of parallel feed fetchers (1-20)
84
+
85
+ **Optional flags:**
86
+ - \`--on-startup\`: Sync feeds when daemon starts (default: true)
87
+ - \`--jitter\`: Random delay in seconds to avoid thundering herd (default: 0)
88
+
78
89
  ### add
79
90
  Add a new RSS feed subscription.
80
91
 
@@ -157,26 +168,46 @@ Show content storage paths.
157
168
  scripts/rss-feed path
158
169
  \`\`\`
159
170
 
160
- ## Agent Workflow
171
+ ## Initial Setup Workflow
172
+
173
+ **When first using rss-feed, follow this workflow:**
174
+
175
+ 1. **Check if already initialized:**
176
+ \`\`\`bash
177
+ scripts/rss-feed status
178
+ \`\`\`
179
+
180
+ 2. **If not initialized (status shows error or no feeds.yaml):**
181
+ \`\`\`bash
182
+ scripts/rss-feed init --interval 30m --concurrency 5
183
+ \`\`\`
184
+
185
+ 3. **Add feeds and sync:**
186
+ \`\`\`bash
187
+ scripts/rss-feed add "Feed Name" "https://example.com/rss.xml" --category news
188
+ scripts/rss-feed sync
189
+ \`\`\`
190
+
191
+ ## Daily Usage Workflow
161
192
 
162
- 1. Get unread articles:
193
+ 1. **Check for unread articles:**
163
194
  \`\`\`bash
164
- scripts/rss-feed articles
195
+ scripts/rss-feed articles
165
196
  \`\`\`
166
197
 
167
- 2. Read an article:
198
+ 2. **Read an article:**
168
199
  \`\`\`bash
169
- scripts/rss-feed read 1
200
+ scripts/rss-feed read 1
170
201
  \`\`\`
171
202
 
172
- 3. Archive when done:
203
+ 3. **Archive when done:**
173
204
  \`\`\`bash
174
- scripts/rss-feed archive --all
205
+ scripts/rss-feed archive --all
175
206
  \`\`\`
176
207
 
177
208
  ## Daemon Mode
178
209
 
179
- Configure automatic sync in feeds.yaml:
210
+ Configure automatic sync in feeds.yaml (created by init):
180
211
  \`\`\`yaml
181
212
  sync:
182
213
  enabled: true
@@ -190,6 +221,15 @@ Start background daemon:
190
221
  \`\`\`bash
191
222
  scripts/rss-feed up -d
192
223
  \`\`\`
224
+
225
+ ## Storage
226
+
227
+ All data is stored in the filesystem:
228
+ - \`~/.rss-skill/feeds.yaml\` - Feed subscriptions and sync config
229
+ - \`~/.rss-skill/content/<category>/<feed>/<article>.md\` - Article content
230
+ - \`~/.rss-skill/archive/<category>/<feed>/<article>.md\` - Archived articles
231
+
232
+ No database required - simple markdown files for portability.
193
233
  `,
194
234
 
195
235
  'rss-gh': `---