felo-ai 0.2.11 → 0.2.14

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.
package/CHANGELOG.md CHANGED
@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [0.2.12] - 2026-03-102
9
+
10
+ Streamline the process and reduce the need for confirmation and selection.
11
+
8
12
  ## [0.2.10] - 2026-03-10
9
13
 
10
14
  ### Fixed
package/README.md CHANGED
@@ -1,469 +1,226 @@
1
1
  # Felo AI CLI
2
2
 
3
- **Ask anything. Get current answers. Generate slides from a prompt.**
3
+ <p align="center">
4
+ <img src="https://felo.ai/icon.svg" alt="Felo AI" width="120">
5
+ </p>
4
6
 
5
- [npm package: **felo-ai**](https://www.npmjs.com/package/felo-ai) — Real-time search, PPT generation, web page extraction, YouTube subtitles, and X (Twitter) search from the terminal. Also works as Claude Code skills. Supports Chinese, English, Japanese, and Korean.
7
+ <p align="center">
8
+ <strong>Ask anything. Get current answers. Generate slides from a prompt.</strong>
9
+ </p>
6
10
 
7
- [![npm version](https://img.shields.io/npm/v/felo-ai.svg)](https://www.npmjs.com/package/felo-ai) [![License](https://img.shields.io/badge/license-MIT-green)]()
11
+ <p align="center">
12
+ <a href="https://www.npmjs.com/package/felo-ai"><img src="https://img.shields.io/npm/v/felo-ai.svg?style=for-the-badge" alt="npm version"></a>
13
+ <a href="https://discord.gg/9W8NubHA"><img src="https://img.shields.io/discord/1078608933607976980?label=Discord&logo=discord&logoColor=white&color=5865F2&style=for-the-badge" alt="Discord"></a>
14
+ <a href="https://x.com/felo_ai"><img src="https://img.shields.io/badge/X-@felo__ai-black?logo=x&style=for-the-badge" alt="X (Twitter)"></a>
15
+ <a href="./felo-search/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" alt="MIT License"></a>
16
+ </p>
8
17
 
9
- ---
18
+ **Felo AI CLI** — Real-time search, PPT generation, web fetch, YouTube subtitles, and X (Twitter) search from the terminal. Also works as Claude Code skills. Supports Chinese, English, Japanese, and Korean.
10
19
 
11
- ## Install (CLI)
20
+ <p align="center">
21
+ <a href="https://felo.ai">Felo AI</a> · <a href="https://openapi.felo.ai/docs/">Docs</a> · <a href="https://openapi.felo.ai/docs/api-reference/v2/chat.html">API Reference</a> · <a href="./docs/EXAMPLES.md">Examples</a> · <a href="./docs/FAQ.md">FAQ</a> · <a href="https://clawhub.ai/u/wangzhiming1999">ClawHub</a> · <a href="https://discord.gg/9W8NubHA">Discord</a> · <a href="https://x.com/felo_ai">X (Twitter)</a>
22
+ </p>
12
23
 
13
- ```bash
14
- npm install -g felo-ai
15
- ```
24
+ ---
16
25
 
17
- Run without installing:
26
+ ## Install
18
27
 
19
28
  ```bash
20
- npx felo-ai search "Tokyo weather"
21
- npx felo-ai slides "Introduction to React, 5 slides"
29
+ npm install -g felo-ai
22
30
  ```
23
31
 
24
- After install, the command is `felo` (package name: **felo-ai**).
25
-
26
- ### Configure API key
27
-
28
- **Option 1: Persist with config (recommended)**
32
+ Get your API key from [Felo AI](https://felo.ai) (Settings API Keys), then:
29
33
 
30
34
  ```bash
31
35
  felo config set FELO_API_KEY your-api-key-here
32
36
  ```
33
37
 
34
- The key is stored in `~/.felo/config.json` (Windows: `%USERPROFILE%\.felo\config.json`). You only need to set it once.
35
-
36
- **Option 2: Environment variable**
38
+ That's it. The key is persisted in `~/.felo/config.json`. You can also use environment variables as an alternative:
37
39
 
38
40
  ```bash
39
- # Linux/macOS
40
- export FELO_API_KEY="your-api-key-here"
41
-
42
- # Windows (PowerShell)
43
- $env:FELO_API_KEY="your-api-key-here"
41
+ export FELO_API_KEY="..." # Linux/macOS
42
+ $env:FELO_API_KEY="..." # Windows (PowerShell)
44
43
  ```
45
44
 
46
- Get your API key from [felo.ai](https://felo.ai) (Settings → API Keys). Environment variable overrides config if both are set.
45
+ ---
47
46
 
48
- ### Commands
47
+ ## Commands
49
48
 
50
- | Command | Description |
51
- | ------------------------------------ | ----------------------------------------------------- |
52
- | `felo search "<query>"` | Search for current info (weather, news, prices, etc.) |
53
- | `felo slides "<prompt>"` | Generate PPT; returns link when done |
54
- | `felo web-fetch --url <url>` | Fetch webpage content (markdown/text/html) |
55
- | `felo youtube-subtitling -v <url-or-id>` | Fetch YouTube video subtitles by video URL or ID |
56
- | `felo x "<query>"` | Search X (Twitter) tweets, users, and replies |
57
- | `felo config set FELO_API_KEY <key>` | Save API key to config |
58
- | `felo config get FELO_API_KEY` | Print stored key |
59
- | `felo config list` | List config keys |
60
- | `felo config path` | Show config file path |
49
+ | Command | Description |
50
+ | ---------------------------------------- | ----------------------------------------------------- |
51
+ | `felo search "<query>"` | Search for current info (weather, news, prices, etc.) |
52
+ | `felo slides "<prompt>"` | Generate PPT; returns link when done |
53
+ | `felo web-fetch --url <url>` | Fetch webpage content (markdown/text/html) |
54
+ | `felo youtube-subtitling -v <url-or-id>` | Fetch YouTube video subtitles |
55
+ | `felo x "<query>"` | Search X (Twitter) tweets, users, and replies |
56
+ | `felo livedoc <subcommand>` | Manage LiveDocs (knowledge bases) and resources |
57
+ | `felo config <set\|get\|list\|path>` | Manage API key and config |
61
58
 
62
- ### Examples
59
+ ---
60
+
61
+ ## Examples
63
62
 
64
63
  **Search**
65
64
 
66
65
  ```bash
67
66
  felo search "Tokyo weather"
68
- felo search "MacBook Air M3 price"
69
67
  felo search "React 19 new features" --verbose
70
- felo search "Hangzhou tomorrow weather" --json
71
- npx felo-ai search "Tokyo weather"
68
+ felo search "MacBook Air M3 price" --json
72
69
  ```
73
70
 
74
71
  **Slides**
75
72
 
76
73
  ```bash
77
74
  felo slides "Felo product intro, 3 slides"
78
- felo slides "Introduction to React"
79
75
  felo slides "Q4 2024 business review, 10 pages" --poll-timeout 300
80
- npx felo-ai slides "Tokyo travel guide, 5 slides"
81
76
  ```
82
77
 
83
- **Web fetch** (after `npm install -g felo-ai`)
78
+ **Web Fetch** [full options →](./felo-web-fetch/README.md)
84
79
 
85
80
  ```bash
86
- # Packaged CLI
87
81
  felo web-fetch --url "https://example.com"
88
- felo web-fetch --url "https://example.com/article" --format markdown --readability
89
- felo web-fetch --url "https://example.com" --target-selector "article.main" --format text
90
- felo web-fetch --url "https://example.com" -j
91
- npx felo-ai web-fetch --url "https://example.com" --format markdown
92
-
93
- # From repo: run script directly (no install)
94
- node felo-web-fetch/scripts/run_web_fetch.mjs --url "https://example.com" --format markdown
95
- node felo-web-fetch/scripts/run_web_fetch.mjs --url "https://example.com" --readability -f text
96
- ```
97
-
98
- **How to pass parameters**
99
-
100
- | Parameter | CLI option | Example | Description |
101
- |-----------|------------|---------|--------------|
102
- | URL (required) | `-u`, `--url` | `--url "https://example.com"` | Page to fetch |
103
- | Output format | `-f`, `--format` | `--format text` or `-f markdown` | `html`, `text`, or `markdown` (default: markdown) |
104
- | Target element | `--target-selector` | `--target-selector "article.main"` | CSS selector; only this element is fetched |
105
- | Wait for element | `--wait-for-selector` | `--wait-for-selector ".content"` | Wait for selector before fetching (e.g. dynamic pages) |
106
- | Readability | `--readability` | `--readability` | Main article content only (no nav/ads) |
107
- | Crawl mode | `--crawl-mode` | `--crawl-mode fine` | `fast` (default) or `fine` |
108
- | Timeout (seconds) | `-t`, `--timeout` | `--timeout 120` or `-t 90` | Request timeout (default: 60) |
109
- | Full JSON response | `-j`, `--json` | `-j` or `--json` | Print full API response instead of content only |
110
-
111
- Examples with multiple options:
112
-
113
- ```bash
114
- felo web-fetch -u "https://example.com" -f text --readability -t 90
115
- felo web-fetch --url "https://example.com" --target-selector "#main" --wait-for-selector ".loaded" --format markdown --json
82
+ felo web-fetch --url "https://example.com" --format markdown --readability
116
83
  ```
117
84
 
118
- Same `FELO_API_KEY` as search/slides.
119
-
120
- **YouTube subtitling** (after `npm install -g felo-ai`)
85
+ **YouTube Subtitling** [full options →](./felo-youtube-subtitling/README.md)
121
86
 
122
87
  ```bash
123
- # Packaged CLI
124
88
  felo youtube-subtitling -v "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
125
- felo youtube-subtitling -v "dQw4w9WgXcQ" --language zh-CN
126
- felo youtube-subtitling -v "https://youtu.be/dQw4w9WgXcQ" --with-time -j
127
- npx felo-ai youtube-subtitling -v "dQw4w9WgXcQ"
128
-
129
- # From repo: run script directly (no install)
130
- node felo-youtube-subtitling/scripts/run_youtube_subtitling.mjs --video-code "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
131
- node felo-youtube-subtitling/scripts/run_youtube_subtitling.mjs -v "dQw4w9WgXcQ" -l zh-CN --with-time
89
+ felo youtube-subtitling -v "dQw4w9WgXcQ" --language zh-CN --with-time
132
90
  ```
133
91
 
134
- Options: `-v/--video-code` (required: **YouTube video URL** or video ID), `-l/--language` (e.g. en, zh-CN), `--with-time`, `-j/--json`. Same `FELO_API_KEY` as other commands. See [felo-youtube-subtitling](./felo-youtube-subtitling/README.md).
135
-
136
- **X (Twitter) search** (after `npm install -g felo-ai`)
92
+ **X (Twitter) Search** [full options ](./felo-x-search/SKILL.md)
137
93
 
138
94
  ```bash
139
- # Search tweets
140
- felo x "AI news"
141
- felo x "AI news" --limit 10 --json
142
-
143
- # Search users
144
- felo x "OpenAI" --user
145
-
146
- # Get user info
147
- felo x --id "elonmusk" --user
148
-
149
- # Get user tweets
150
- felo x --id "elonmusk" --user --tweets
151
- felo x --id "elonmusk" --user --tweets --include-replies --limit 20
152
-
153
- # Get tweet replies
154
- felo x --id "1234567890"
155
-
156
- # From repo: run script directly (no install)
157
- node felo-x-search/scripts/run_x_search.mjs "AI news"
95
+ felo x "AI news" # Search tweets
96
+ felo x "OpenAI" --user # Search users
97
+ felo x --id "elonmusk" --user # Get user info
98
+ felo x --id "elonmusk" --user --tweets # Get user tweets
99
+ felo x --id "1234567890" # Get tweet replies
158
100
  ```
159
101
 
160
- Options: `[query]` or `-q/--query` (search keyword), `--id` (tweet IDs or usernames, comma-separated), `--user` (user mode), `--tweets` (get user tweets), `-l/--limit`, `--cursor`, `--include-replies`, `--query-type`, `--since-time`, `--until-time`, `-j/--json`, `-t/--timeout`. Same `FELO_API_KEY` as other commands. See [felo-x-search](./felo-x-search/SKILL.md).
161
-
162
- ### CLI FAQ
163
-
164
- - **Key not found?** Run `felo config set FELO_API_KEY <key>` or set the `FELO_API_KEY` environment variable.
165
- - **Request timeout?** Use `felo search "query" --timeout 120` (default 60 seconds). 5xx errors are retried automatically with backoff.
166
- - **Slides taking long?** Use `felo slides "topic" --poll-timeout 300` (default 1200s) to limit wait.
167
- - **Where is config stored?** Run `felo config path` to see the file (e.g. `~/.felo/config.json`).
168
- - **Web fetch after install?** Use `felo web-fetch --url "<page url>"`. Other params: `--format markdown|text|html`, `--readability`, `--target-selector "selector"`, `--wait-for-selector "selector"`, `--crawl-mode fast|fine`, `--timeout 120`, `--json`. See the "How to pass parameters" table above. Same API key as other commands.
169
- - **YouTube subtitles?** Use `felo youtube-subtitling -v "<url or video_id>"` (full YouTube link or 11-char ID). Optional: `-l/--language`, `--with-time`, `-j/--json`. See [felo-youtube-subtitling](./felo-youtube-subtitling/README.md).
170
- - **X (Twitter) search?** Use `felo x "<query>"` to search tweets, `felo x "<query>" --user` to search users, `felo x --id "<username>" --user` for user info, `felo x --id "<username>" --user --tweets` for user tweets, `felo x --id "<tweet_id>"` for tweet replies. See [felo-x-search](./felo-x-search/SKILL.md).
171
-
172
- ---
173
-
174
- ## Claude Code Skills (optional)
175
-
176
- This repo also provides **Claude Code** skills. If you use [Claude Code](https://claude.ai/code), you can install search and/or slides as skills so Claude can run them in chat.
177
-
178
- ### Quick Start (Search skill)
179
-
180
- Install the skill:
102
+ **LiveDoc (Knowledge Base)** [full options ](./felo-livedoc/README.md)
181
103
 
182
104
  ```bash
183
- npx @claude/skills add felo-search
105
+ felo livedoc create --name "My KB" --description "Project docs"
106
+ felo livedoc list
107
+ felo livedoc add-doc SHORT_ID --content "Hello" --title "Test"
108
+ felo livedoc add-urls SHORT_ID --urls "https://example.com"
109
+ felo livedoc upload SHORT_ID --file ./doc.pdf
110
+ felo livedoc retrieve SHORT_ID --query "search query"
184
111
  ```
185
112
 
186
- Get your API key from [felo.ai](https://felo.ai) (Settings → API Keys), then configure:
187
-
188
- **Linux/macOS:**
189
-
190
- ```bash
191
- export FELO_API_KEY="your-api-key-here"
192
- # Add to ~/.bashrc or ~/.zshrc for persistence
193
- ```
194
-
195
- **Windows (PowerShell):**
196
-
197
- ```powershell
198
- $env:FELO_API_KEY="your-api-key-here"
199
- # For persistence, add to system environment variables
200
- ```
201
-
202
- Test it:
203
-
204
- ```
205
- Ask Claude: "What's the weather in Tokyo today?"
206
- ```
207
-
208
- **You're done!** The skill triggers automatically for any question needing current information.
113
+ **[See 40+ more examples ](./docs/EXAMPLES.md)**
209
114
 
210
- **Felo Slides (PPT):** In terminal run `felo slides "your topic"`. In Claude Code install with `npx @claude/skills add felo-slides`, then use `/felo-slides your topic`. See [felo-slides](./felo-slides/README.md).
115
+ ---
211
116
 
212
- **Felo Web Fetch:** In terminal run `felo web-fetch --url "https://example.com"` (see [felo-web-fetch](./felo-web-fetch/README.md)). In Claude Code you can install the skill and use it to fetch webpage content from a URL.
117
+ ## Skills Overview
213
118
 
214
- **Felo YouTube Subtitling:** In terminal run `felo youtube-subtitling -v "URL_or_VIDEO_ID"` (see [felo-youtube-subtitling](./felo-youtube-subtitling/README.md)). Fetches subtitles/captions; accepts full YouTube link or video ID.
119
+ 5 skills across search, content generation, web scraping, and social media:
215
120
 
216
- **Felo X Search:** In terminal run `felo x "query"` to search tweets, users, and replies on X (Twitter) (see [felo-x-search](./felo-x-search/SKILL.md)). In Claude Code install the skill and use it to search X content.
121
+ | Skill | Description | Docs |
122
+ | --------------------------- | ------------------------------------------------------------- | ------------------------------- |
123
+ | **felo-search** | Real-time web search with AI answers. Triggers automatically. | [→](./felo-search/) |
124
+ | **felo-slides** | Generate PPT from a prompt | [→](./felo-slides/) |
125
+ | **felo-web-fetch** | Fetch and extract webpage content | [→](./felo-web-fetch/) |
126
+ | **felo-youtube-subtitling** | Fetch YouTube video subtitles | [→](./felo-youtube-subtitling/) |
127
+ | **felo-x-search** | Search X (Twitter) tweets, users, replies | [→](./felo-x-search/SKILL.md) |
128
+ | **felo-livedoc** | Manage knowledge bases and semantic retrieval | [→](./felo-livedoc/) |
217
129
 
218
130
  ---
219
131
 
220
- ## Usage Examples
132
+ ## Skills Install
221
133
 
222
- ### Daily life
223
-
224
- **Weather**
225
-
226
- ```
227
- You: What's the weather in Tokyo today?
228
- Claude: [Current temperature, conditions, forecast]
229
- ```
134
+ ### Claude Code (Recommended)
230
135
 
231
- **Restaurants & food**
136
+ ```bash
137
+ # Add the marketplace
138
+ /plugin marketplace add Felo-Inc/felo-skills
232
139
 
140
+ # Install individual skills
141
+ /plugin install felo-search@felo-ai
142
+ /plugin install felo-slides@felo-ai
143
+ /plugin install felo-web-fetch@felo-ai
144
+ /plugin install felo-youtube-subtitling@felo-ai
145
+ /plugin install felo-x-search@felo-ai
146
+ /plugin install felo-livedoc@felo-ai
233
147
  ```
234
- You: Best ramen in Osaka
235
- Claude: [Top-rated ramen shops with addresses, ratings, reviews]
236
- ```
237
-
238
- **Shopping & prices**
239
148
 
240
- ```
241
- You: iPhone 15 Pro price comparison
242
- Claude: [Prices from different retailers with links]
243
- ```
149
+ ### ClawHub
244
150
 
245
- **Travel**
151
+ [ClawHub](https://clawhub.ai) is a public skill registry for AI coding agents. Browse all Felo skills on [ClawHub](https://clawhub.ai/u/wangzhiming1999).
246
152
 
247
- ```
248
- You: Things to do in Kyoto this weekend
249
- Claude: [Events, attractions, seasonal activities]
153
+ ```bash
154
+ clawhub install felo-search
155
+ clawhub install felo-slides
156
+ clawhub install felo-web-fetch
157
+ clawhub install felo-youtube-subtitling
158
+ clawhub install felo-x-search
159
+ clawhub install felo-livedoc
250
160
  ```
251
161
 
252
- ### Developer scenarios
162
+ ### Gemini CLI
253
163
 
254
- **Latest documentation**
164
+ ```bash
165
+ git clone https://github.com/Felo-Inc/felo-skills.git
166
+ cd felo-skills
255
167
 
256
- ```
257
- You: React 19 new features
258
- Claude: [Latest React 19 features with official docs links]
168
+ # Copy skill folders to Gemini CLI skills directory
169
+ cp -r felo-search ~/.gemini/skills/
170
+ cp -r felo-slides ~/.gemini/skills/
259
171
  ```
260
172
 
261
- **Library comparison**
173
+ ### OpenAI Codex
262
174
 
263
- ```
264
- You: Vite vs Webpack 2024 comparison
265
- Claude: [Performance, features, use cases comparison]
175
+ ```bash
176
+ git clone https://github.com/Felo-Inc/felo-skills.git
177
+ # Copy any skill folder to ~/.codex/skills/
178
+ cp -r felo-search ~/.codex/skills/
266
179
  ```
267
180
 
268
- **Tech trends**
181
+ ### OpenClaw
269
182
 
183
+ ```bash
184
+ bash <(curl -s https://raw.githubusercontent.com/Felo-Inc/felo-skills/main/scripts/openclaw-install.sh)
270
185
  ```
271
- You: Latest AI developments January 2026
272
- Claude: [Recent AI breakthroughs, company announcements]
273
- ```
274
-
275
- ### Multi-language queries
276
-
277
- Works in Chinese (Simplified & Traditional), Japanese, Korean, and English. Ask in any language, get answers in that language.
278
-
279
- **[See 40+ more examples →](./docs/EXAMPLES.md)**
280
186
 
281
- ---
282
-
283
- ## Installation details
284
-
285
- ### Prerequisites
286
-
287
- - [Claude Code](https://claude.ai/code) CLI installed
288
- - Node.js (for npx)
289
- - Internet connection
290
-
291
- ### Manual installation
292
-
293
- If quick install doesn’t work:
294
-
295
- 1. Clone this repository:
296
-
297
- ```bash
298
- git clone https://github.com/Felo-Inc/felo-skills.git
299
- cd felo-skills
300
- ```
301
-
302
- 2. Copy to Claude Code skills directory:
303
-
304
- - **Linux/macOS:** `~/.claude/skills/`
305
- - **Windows:** `C:\Users\<YourUsername>\.claude\skills\`
306
-
307
- ```bash
308
- # Linux/macOS
309
- cp -r felo-search ~/.claude/skills/
310
-
311
- # Windows (PowerShell)
312
- Copy-Item -Recurse felo-search "$env:USERPROFILE\.claude\skills\"
313
- ```
314
-
315
- 3. Get API key from [felo.ai](https://felo.ai) (Settings → API Keys)
316
-
317
- 4. Set environment variable (see Quick Start)
318
-
319
- 5. Restart Claude Code: `claude restart`
320
-
321
- ### Verify installation
187
+ ### Manual Installation
322
188
 
323
189
  ```bash
324
- claude skills list
190
+ git clone https://github.com/Felo-Inc/felo-skills.git
191
+ # Copy any skill folder to the skills directory of your AI coding agent
192
+ # Claude Code: ~/.claude/skills/
193
+ # Gemini CLI: ~/.gemini/skills/
194
+ # Codex: ~/.codex/skills/
195
+ cp -r felo-search ~/.claude/skills/
325
196
  ```
326
197
 
327
- You should see `felo-search` in the output.
328
-
329
- Test: ask Claude _"Latest news about quantum computing"_. If you see an AI-generated answer, it’s working.
330
-
331
198
  ---
332
199
 
333
200
  ## FAQ
334
201
 
335
- ### Q: Skill not triggering automatically?
336
-
337
- **A:** The skill triggers for questions needing current info (weather, news, prices, etc.). For manual trigger, use:
338
-
339
- ```
340
- /felo-search your query here
341
- ```
342
-
343
- ### Q: "FELO_API_KEY not set" error?
344
-
345
- **A:** Set the environment variable (see Quick Start), then restart Claude Code.
346
-
347
- ### Q: Environment variable not persisting?
348
-
349
- **A:** Add to your shell profile: **bash** `~/.bashrc`, **zsh** `~/.zshrc`, **Windows** system environment variables.
350
-
351
- ### Q: "INVALID_API_KEY" error?
352
-
353
- **A:** Your API key is incorrect or revoked. Generate a new one at [felo.ai](https://felo.ai) (Settings → API Keys).
354
-
355
- ### Q: Does it work in Chinese/Japanese/Korean?
356
-
357
- **A:** Yes. Multi-language queries are supported; ask in any language.
358
-
359
- ### Q: Rate limits?
360
-
361
- **A:** Check your Felo account tier at [felo.ai](https://felo.ai). Free tier available.
362
-
363
- ### Q: Can I use it offline?
364
-
365
- **A:** No, it requires an internet connection to the Felo API.
366
-
367
- ### Q: How fast are responses?
368
-
369
- **A:** Typically 2–5 seconds depending on query complexity.
202
+ - **Key not found?** Run `felo config set FELO_API_KEY <key>` or set the `FELO_API_KEY` environment variable.
203
+ - **Request timeout?** Use `--timeout 120` (default 60s). 5xx errors are retried automatically.
204
+ - **Slides taking long?** Use `--poll-timeout 300` (default 1200s) to limit wait.
205
+ - **Skill not triggering?** Use `/felo-search your query` to trigger manually.
206
+ - **Multi-language?** Yes — Chinese, English, Japanese, and Korean are supported.
370
207
 
371
208
  **[Full FAQ →](./docs/FAQ.md)**
372
209
 
373
210
  ---
374
211
 
375
- ## Available Skills
376
-
377
- ### felo-search
378
-
379
- Real-time web search with AI-generated answers.
380
-
381
- **Triggers automatically for:**
382
-
383
- - Current events & news
384
- - Weather, prices, reviews
385
- - Location info (restaurants, attractions)
386
- - Latest documentation & tech trends
387
- - Product comparisons
388
- - Any question with "latest", "recent", "best", "how to"
389
-
390
- **[View skill documentation →](./felo-search/)**
391
-
392
- ### felo-slides
393
-
394
- Generate PPT: in terminal use `felo slides "your topic"`, in Claude Code use `/felo-slides your topic`. **[View skill documentation →](./felo-slides/)**
395
-
396
- ### felo-web-fetch
397
-
398
- Fetch and extract webpage content: in terminal use `felo web-fetch --url "https://example.com"`, in Claude Code use `/felo-web-fetch https://example.com`. **[View skill documentation →](./felo-web-fetch/)**
399
-
400
- ### felo-x-search
401
-
402
- Search X (Twitter) tweets, users, and replies: in terminal use `felo x "query"`, in Claude Code use `/felo-x-search query`. **[View skill documentation →](./felo-x-search/SKILL.md)**
403
-
404
- ---
405
-
406
212
  ## Contributing
407
213
 
408
- We welcome contributions:
409
-
410
- - Report bugs or request features
411
- - Improve documentation
412
- - Add new skills
413
-
414
- Run CLI tests: `npm test`
214
+ We welcome contributions — report bugs, improve docs, or add new skills. Run tests with `npm test`.
415
215
 
416
216
  **[Contributing guide →](./CONTRIBUTING.md)**
417
217
 
418
218
  ---
419
219
 
420
- ## Links
421
-
422
- - **[npm: felo-ai](https://www.npmjs.com/package/felo-ai)** — CLI package
423
- - **[Felo Open Platform](https://openapi.felo.ai/docs/)** — Get your API key
424
- - **[API Documentation](https://openapi.felo.ai/docs/api-reference/v2/chat.html)** — API reference
425
- - **[Claude Code](https://claude.ai/code)** — AI assistant CLI
426
- - **[Full examples](./docs/EXAMPLES.md)** — 40+ usage examples
427
- - **[FAQ](./docs/FAQ.md)** — Troubleshooting
428
- - **[GitHub Issues](https://github.com/Felo-Inc/felo-skills/issues)** — Report bugs
429
-
430
- ---
431
-
432
- ## Publishing to npm (maintainers)
433
-
434
- 自动发布由 GitHub Actions 在**推送 tag** 时执行(参考 [editablejs/editable](https://github.com/editablejs/editable/blob/main/.github/workflows/main.yml) 的流程思路)。
435
-
436
- 1. **配置 NPM_TOKEN**
437
- 在 [npm Access Tokens](https://www.npmjs.com/account/tokens) 创建 **Automation** 类型、具备 Publish 权限的 token,在仓库 **Settings → Secrets and variables → Actions** 里添加名为 `NPM_TOKEN` 的 secret。
438
-
439
- 2. **发布新版本**
440
- 更新 `package.json` 的 `version`,提交并推送,然后打 tag 并推送:
441
- ```bash
442
- git tag v0.2.8
443
- git push origin v0.2.8
444
- ```
445
- CI 会跑测试并通过 `npm publish` 发布到 [npm](https://www.npmjs.com/package/felo-ai)。
446
-
447
- ---
448
-
449
- ## Support
450
-
451
- - **Documentation**: [FAQ](./docs/FAQ.md) and skill READMEs
452
- - **Issues**: [GitHub Issues](https://github.com/Felo-Inc/felo-skills/issues)
453
- - **Email**: support@felo.ai
454
-
455
- ---
456
-
457
- ## Version history
458
-
459
- See [CHANGELOG.md](./CHANGELOG.md) for release notes (e.g. breaking changes such as `web-extract` → `web-fetch` in v0.2.7).
460
-
461
- ---
462
-
463
220
  ## License
464
221
 
465
- MIT — see [LICENSE](./felo-search/LICENSE) in the repo for details.
222
+ MIT — see [LICENSE](./felo-search/LICENSE) for details.
466
223
 
467
224
  ---
468
225
 
469
- Made with ❤️ by the Felo team
226
+ <p align="center">Made with ❤️ by the <a href="https://felo.ai">Felo</a> team</p>
package/docs/FAQ.md CHANGED
@@ -18,21 +18,25 @@ Quick answers to common questions about Felo Search skill.
18
18
 
19
19
  **A:** Install Node.js first.
20
20
 
21
- Download from [nodejs.org](https://nodejs.org) and install. Then retry:
21
+ Download from [nodejs.org](https://nodejs.org) and install. 然后可用一键安装:
22
+
22
23
  ```bash
23
- npx @claude/skills add felo-search
24
+ npx skills add Felo-Inc/felo-skills --skill felo-search
24
25
  ```
25
26
 
27
+ 若失败,请使用 [README 中的手动安装](https://github.com/Felo-Inc/felo-skills#manual-installation):将 `felo-search` 复制到 `~/.claude/skills/`(Windows: `%USERPROFILE%\.claude\skills\`)。
28
+
26
29
  ### Q: Permission denied during install
27
30
 
28
- **A:** Use elevated privileges.
31
+ **A:** 若复制目录时权限不足,可用一键安装(无需 sudo):
29
32
 
30
- **Linux/macOS:**
31
33
  ```bash
32
- sudo npx @claude/skills add felo-search
34
+ npx skills add Felo-Inc/felo-skills --skill felo-search
33
35
  ```
34
36
 
35
- **Windows:** Run PowerShell or CMD as Administrator.
37
+ **Linux/macOS 手动复制:** 确保 `~/.claude/skills/` 存在且有写权限后执行 `cp -r felo-search ~/.claude/skills/`。
38
+
39
+ **Windows:** 若复制到 `%USERPROFILE%\.claude\skills\` 失败,请以管理员身份运行 PowerShell。
36
40
 
37
41
  ### Q: Skill not showing up after install
38
42
 
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Felo LiveDoc Skill Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.