felo-ai 0.2.12 → 0.2.15
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/README.md +113 -374
- package/felo-livedoc/LICENSE +21 -0
- package/felo-livedoc/README.md +53 -0
- package/felo-livedoc/SKILL.md +180 -0
- package/felo-livedoc/scripts/run_livedoc.mjs +391 -0
- package/felo-superAgent/README.md +4 -3
- package/felo-superAgent/SKILL.md +5 -8
- package/package.json +4 -2
- package/src/cli.js +205 -0
- package/src/livedoc.js +401 -0
package/README.md
CHANGED
|
@@ -1,487 +1,226 @@
|
|
|
1
1
|
# Felo AI CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="https://felo.ai/icon.svg" alt="Felo AI" width="120">
|
|
5
|
+
</p>
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
<p align="center">
|
|
8
|
+
<strong>Ask anything. Get current answers. Generate slides from a prompt.</strong>
|
|
9
|
+
</p>
|
|
6
10
|
|
|
7
|
-
|
|
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
|
-
|
|
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
|
-
|
|
14
|
-
npm install -g felo-ai
|
|
15
|
-
```
|
|
24
|
+
---
|
|
16
25
|
|
|
17
|
-
|
|
26
|
+
## Install
|
|
18
27
|
|
|
19
28
|
```bash
|
|
20
|
-
|
|
21
|
-
npx felo-ai slides "Introduction to React, 5 slides"
|
|
29
|
+
npm install -g felo-ai
|
|
22
30
|
```
|
|
23
31
|
|
|
24
|
-
|
|
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
|
|
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
|
-
|
|
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
|
-
|
|
45
|
+
---
|
|
47
46
|
|
|
48
|
-
|
|
47
|
+
## Commands
|
|
49
48
|
|
|
50
49
|
| Command | Description |
|
|
51
50
|
| ---------------------------------------- | ----------------------------------------------------- |
|
|
52
51
|
| `felo search "<query>"` | Search for current info (weather, news, prices, etc.) |
|
|
53
52
|
| `felo slides "<prompt>"` | Generate PPT; returns link when done |
|
|
54
53
|
| `felo web-fetch --url <url>` | Fetch webpage content (markdown/text/html) |
|
|
55
|
-
| `felo youtube-subtitling -v <url-or-id>` | Fetch YouTube video subtitles
|
|
54
|
+
| `felo youtube-subtitling -v <url-or-id>` | Fetch YouTube video subtitles |
|
|
56
55
|
| `felo x "<query>"` | Search X (Twitter) tweets, users, and replies |
|
|
57
|
-
| `felo
|
|
58
|
-
| `felo config get
|
|
59
|
-
|
|
60
|
-
|
|
56
|
+
| `felo livedoc <subcommand>` | Manage LiveDocs (knowledge bases) and resources |
|
|
57
|
+
| `felo config <set\|get\|list\|path>` | Manage API key and config |
|
|
58
|
+
|
|
59
|
+
---
|
|
61
60
|
|
|
62
|
-
|
|
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 "
|
|
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
|
|
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
|
|
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
|
|
82
|
+
felo web-fetch --url "https://example.com" --format markdown --readability
|
|
96
83
|
```
|
|
97
84
|
|
|
98
|
-
**
|
|
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:
|
|
85
|
+
**YouTube Subtitling** — [full options →](./felo-youtube-subtitling/README.md)
|
|
112
86
|
|
|
113
87
|
```bash
|
|
114
|
-
felo
|
|
115
|
-
felo
|
|
88
|
+
felo youtube-subtitling -v "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
|
|
89
|
+
felo youtube-subtitling -v "dQw4w9WgXcQ" --language zh-CN --with-time
|
|
116
90
|
```
|
|
117
91
|
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
**YouTube subtitling** (after `npm install -g felo-ai`)
|
|
92
|
+
**X (Twitter) Search** — [full options →](./felo-x-search/SKILL.md)
|
|
121
93
|
|
|
122
94
|
```bash
|
|
123
|
-
#
|
|
124
|
-
felo
|
|
125
|
-
felo
|
|
126
|
-
felo
|
|
127
|
-
|
|
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
|
|
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
|
|
132
100
|
```
|
|
133
101
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
**X (Twitter) search** (after `npm install -g felo-ai`)
|
|
102
|
+
**LiveDoc (Knowledge Base)** — [full options →](./felo-livedoc/README.md)
|
|
137
103
|
|
|
138
104
|
```bash
|
|
139
|
-
|
|
140
|
-
felo
|
|
141
|
-
felo
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
felo
|
|
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"
|
|
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"
|
|
158
111
|
```
|
|
159
112
|
|
|
160
|
-
|
|
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).
|
|
113
|
+
**[See 40+ more examples →](./docs/EXAMPLES.md)**
|
|
171
114
|
|
|
172
115
|
---
|
|
173
116
|
|
|
174
|
-
##
|
|
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.
|
|
117
|
+
## Skills Overview
|
|
177
118
|
|
|
178
|
-
|
|
119
|
+
5 skills across search, content generation, web scraping, and social media:
|
|
179
120
|
|
|
180
|
-
|
|
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/) |
|
|
181
129
|
|
|
182
|
-
|
|
183
|
-
npx skills add Felo-Inc/felo-skills --skill felo-search
|
|
184
|
-
```
|
|
130
|
+
---
|
|
185
131
|
|
|
186
|
-
|
|
132
|
+
## Skills Install
|
|
187
133
|
|
|
188
|
-
|
|
134
|
+
### Claude Code (Recommended)
|
|
189
135
|
|
|
190
136
|
```bash
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
```
|
|
137
|
+
# Add the marketplace
|
|
138
|
+
/plugin marketplace add Felo-Inc/felo-skills
|
|
194
139
|
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
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
|
|
200
147
|
```
|
|
201
148
|
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
Get your API key from [felo.ai](https://felo.ai) (Settings > API Keys), then configure:
|
|
149
|
+
### ClawHub
|
|
205
150
|
|
|
206
|
-
|
|
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).
|
|
207
152
|
|
|
208
153
|
```bash
|
|
209
|
-
|
|
210
|
-
|
|
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
|
|
211
160
|
```
|
|
212
161
|
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
```powershell
|
|
216
|
-
$env:FELO_API_KEY="your-api-key-here"
|
|
217
|
-
# For persistence, add to system environment variables
|
|
218
|
-
```
|
|
162
|
+
### Gemini CLI
|
|
219
163
|
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
Ask Claude: "What's the weather in Tokyo today?"
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
**You're done!** The skill triggers automatically for any question needing current information.
|
|
227
|
-
|
|
228
|
-
**Felo Slides (PPT):** In terminal run `felo slides "your topic"`. In Claude Code install with `npx skills add Felo-Inc/felo-skills --skill felo-slides`, then use `/felo-slides your topic`. See [felo-slides](./felo-slides/README.md).
|
|
229
|
-
|
|
230
|
-
**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.
|
|
231
|
-
|
|
232
|
-
**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.
|
|
233
|
-
|
|
234
|
-
**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.
|
|
235
|
-
|
|
236
|
-
---
|
|
237
|
-
|
|
238
|
-
## Usage Examples
|
|
239
|
-
|
|
240
|
-
### Daily life
|
|
241
|
-
|
|
242
|
-
**Weather**
|
|
243
|
-
|
|
244
|
-
```
|
|
245
|
-
You: What's the weather in Tokyo today?
|
|
246
|
-
Claude: [Current temperature, conditions, forecast]
|
|
247
|
-
```
|
|
248
|
-
|
|
249
|
-
**Restaurants & food**
|
|
250
|
-
|
|
251
|
-
```
|
|
252
|
-
You: Best ramen in Osaka
|
|
253
|
-
Claude: [Top-rated ramen shops with addresses, ratings, reviews]
|
|
254
|
-
```
|
|
255
|
-
|
|
256
|
-
**Shopping & prices**
|
|
257
|
-
|
|
258
|
-
```
|
|
259
|
-
You: iPhone 15 Pro price comparison
|
|
260
|
-
Claude: [Prices from different retailers with links]
|
|
261
|
-
```
|
|
262
|
-
|
|
263
|
-
**Travel**
|
|
264
|
-
|
|
265
|
-
```
|
|
266
|
-
You: Things to do in Kyoto this weekend
|
|
267
|
-
Claude: [Events, attractions, seasonal activities]
|
|
268
|
-
```
|
|
269
|
-
|
|
270
|
-
### Developer scenarios
|
|
271
|
-
|
|
272
|
-
**Latest documentation**
|
|
164
|
+
```bash
|
|
165
|
+
git clone https://github.com/Felo-Inc/felo-skills.git
|
|
166
|
+
cd felo-skills
|
|
273
167
|
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
168
|
+
# Copy skill folders to Gemini CLI skills directory
|
|
169
|
+
cp -r felo-search ~/.gemini/skills/
|
|
170
|
+
cp -r felo-slides ~/.gemini/skills/
|
|
277
171
|
```
|
|
278
172
|
|
|
279
|
-
|
|
173
|
+
### OpenAI Codex
|
|
280
174
|
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
|
|
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/
|
|
284
179
|
```
|
|
285
180
|
|
|
286
|
-
|
|
181
|
+
### OpenClaw
|
|
287
182
|
|
|
183
|
+
```bash
|
|
184
|
+
bash <(curl -s https://raw.githubusercontent.com/Felo-Inc/felo-skills/main/scripts/openclaw-install.sh)
|
|
288
185
|
```
|
|
289
|
-
You: Latest AI developments January 2026
|
|
290
|
-
Claude: [Recent AI breakthroughs, company announcements]
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
### Multi-language queries
|
|
294
186
|
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
**[See 40+ more examples >](./docs/EXAMPLES.md)**
|
|
298
|
-
|
|
299
|
-
---
|
|
300
|
-
|
|
301
|
-
## Installation details
|
|
302
|
-
|
|
303
|
-
### Prerequisites
|
|
304
|
-
|
|
305
|
-
- [Claude Code](https://claude.ai/code) CLI installed
|
|
306
|
-
- Node.js (for npx)
|
|
307
|
-
- Internet connection
|
|
308
|
-
|
|
309
|
-
### Manual installation
|
|
310
|
-
|
|
311
|
-
If you don't want to use `npx skills add` or don't have the skills CLI, you can install it manually:
|
|
312
|
-
|
|
313
|
-
1. Clone this repository:
|
|
314
|
-
|
|
315
|
-
```bash
|
|
316
|
-
git clone https://github.com/Felo-Inc/felo-skills.git
|
|
317
|
-
cd felo-skills
|
|
318
|
-
```
|
|
319
|
-
|
|
320
|
-
2. Copy to Claude Code skills directory:
|
|
321
|
-
|
|
322
|
-
- **Linux/macOS:** `~/.claude/skills/`
|
|
323
|
-
- **Windows:** `C:\Users\<YourUsername>\.claude\skills\`
|
|
324
|
-
|
|
325
|
-
```bash
|
|
326
|
-
# Linux/macOS
|
|
327
|
-
cp -r felo-search ~/.claude/skills/
|
|
328
|
-
|
|
329
|
-
# Windows (PowerShell)
|
|
330
|
-
Copy-Item -Recurse felo-search "$env:USERPROFILE\.claude\skills\"
|
|
331
|
-
```
|
|
332
|
-
|
|
333
|
-
3. Get API key from [felo.ai](https://felo.ai) (Settings > API Keys)
|
|
334
|
-
|
|
335
|
-
4. Set environment variable (see Quick Start)
|
|
336
|
-
|
|
337
|
-
5. Restart Claude Code: `claude restart`
|
|
338
|
-
|
|
339
|
-
### Verify installation
|
|
187
|
+
### Manual Installation
|
|
340
188
|
|
|
341
189
|
```bash
|
|
342
|
-
|
|
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/
|
|
343
196
|
```
|
|
344
197
|
|
|
345
|
-
You should see `felo-search` in the output.
|
|
346
|
-
|
|
347
|
-
Test: ask Claude _"Latest news about quantum computing"_. If you see an AI-generated answer, it's working.
|
|
348
|
-
|
|
349
198
|
---
|
|
350
199
|
|
|
351
200
|
## FAQ
|
|
352
201
|
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
**
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
/felo-search your query here
|
|
359
|
-
```
|
|
360
|
-
|
|
361
|
-
### Q: "FELO_API_KEY not set" error?
|
|
362
|
-
|
|
363
|
-
**A:** Set the environment variable (see Quick Start), then restart Claude Code.
|
|
364
|
-
|
|
365
|
-
### Q: Environment variable not persisting?
|
|
366
|
-
|
|
367
|
-
**A:** Add to your shell profile: **bash** `~/.bashrc`, **zsh** `~/.zshrc`, **Windows** system environment variables.
|
|
368
|
-
|
|
369
|
-
### Q: "INVALID_API_KEY" error?
|
|
370
|
-
|
|
371
|
-
**A:** Your API key is incorrect or revoked. Generate a new one at [felo.ai](https://felo.ai) (Settings > API Keys).
|
|
372
|
-
|
|
373
|
-
### Q: Does it work in Chinese/Japanese/Korean?
|
|
374
|
-
|
|
375
|
-
**A:** Yes. Multi-language queries are supported; ask in any language.
|
|
376
|
-
|
|
377
|
-
### Q: Rate limits?
|
|
378
|
-
|
|
379
|
-
**A:** Check your Felo account tier at [felo.ai](https://felo.ai). Free tier available.
|
|
380
|
-
|
|
381
|
-
### Q: Can I use it offline?
|
|
382
|
-
|
|
383
|
-
**A:** No, it requires an internet connection to the Felo API.
|
|
384
|
-
|
|
385
|
-
### Q: How fast are responses?
|
|
386
|
-
|
|
387
|
-
**A:** Typically 2-5 seconds depending on query complexity.
|
|
388
|
-
|
|
389
|
-
**[Full FAQ >](./docs/FAQ.md)**
|
|
390
|
-
|
|
391
|
-
---
|
|
392
|
-
|
|
393
|
-
## Available Skills
|
|
394
|
-
|
|
395
|
-
### felo-search
|
|
396
|
-
|
|
397
|
-
Real-time web search with AI-generated answers.
|
|
398
|
-
|
|
399
|
-
**Triggers automatically for:**
|
|
400
|
-
|
|
401
|
-
- Current events & news
|
|
402
|
-
- Weather, prices, reviews
|
|
403
|
-
- Location info (restaurants, attractions)
|
|
404
|
-
- Latest documentation & tech trends
|
|
405
|
-
- Product comparisons
|
|
406
|
-
- Any question with "latest", "recent", "best", "how to"
|
|
407
|
-
|
|
408
|
-
**[View skill documentation >](./felo-search/)**
|
|
409
|
-
|
|
410
|
-
### felo-slides
|
|
411
|
-
|
|
412
|
-
Generate PPT: in terminal use `felo slides "your topic"`, in Claude Code use `/felo-slides your topic`. **[View skill documentation >](./felo-slides/)**
|
|
413
|
-
|
|
414
|
-
### felo-web-fetch
|
|
415
|
-
|
|
416
|
-
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/)**
|
|
417
|
-
|
|
418
|
-
### felo-x-search
|
|
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.
|
|
419
207
|
|
|
420
|
-
|
|
208
|
+
**[Full FAQ →](./docs/FAQ.md)**
|
|
421
209
|
|
|
422
210
|
---
|
|
423
211
|
|
|
424
212
|
## Contributing
|
|
425
213
|
|
|
426
|
-
We welcome contributions
|
|
427
|
-
|
|
428
|
-
- Report bugs or request features
|
|
429
|
-
- Improve documentation
|
|
430
|
-
- Add new skills
|
|
431
|
-
|
|
432
|
-
Run CLI tests: `npm test`
|
|
433
|
-
|
|
434
|
-
**[Contributing guide >](./CONTRIBUTING.md)**
|
|
435
|
-
|
|
436
|
-
---
|
|
437
|
-
|
|
438
|
-
## Links
|
|
439
|
-
|
|
440
|
-
- **[npm: felo-ai](https://www.npmjs.com/package/felo-ai)** - CLI package
|
|
441
|
-
- **[Felo Open Platform](https://openapi.felo.ai/docs/)** - Get your API key
|
|
442
|
-
- **[API Documentation](https://openapi.felo.ai/docs/api-reference/v2/chat.html)** - API reference
|
|
443
|
-
- **[Claude Code](https://claude.ai/code)** - AI assistant CLI
|
|
444
|
-
- **[Full examples](./docs/EXAMPLES.md)** - 40+ usage examples
|
|
445
|
-
- **[FAQ](./docs/FAQ.md)** - Troubleshooting
|
|
446
|
-
- **[GitHub Issues](https://github.com/Felo-Inc/felo-skills/issues)** - Report bugs
|
|
447
|
-
|
|
448
|
-
---
|
|
449
|
-
|
|
450
|
-
## Publishing to npm (maintainers)
|
|
451
|
-
|
|
452
|
-
This project uses GitHub Actions to automatically publish when **pushing a tag** (referencing the [editablejs/editable](https://github.com/editablejs/editable/blob/main/.github/workflows/main.yml) publishing workflow).
|
|
453
|
-
|
|
454
|
-
1. **Configure NPM_TOKEN**
|
|
455
|
-
Generate an **Automation** type Publish token in [npm Access Tokens](https://www.npmjs.com/account/tokens). Add a secret named `NPM_TOKEN` in the repository's **Settings > Secrets and variables > Actions**.
|
|
456
|
-
|
|
457
|
-
2. **Publish a new version**
|
|
458
|
-
Update the `version` in `package.json`, then commit and push the tag:
|
|
459
|
-
```bash
|
|
460
|
-
git tag v0.2.8
|
|
461
|
-
git push origin v0.2.8
|
|
462
|
-
```
|
|
463
|
-
CI will automatically run `npm publish` to publish to [npm](https://www.npmjs.com/package/felo-ai).
|
|
464
|
-
|
|
465
|
-
---
|
|
466
|
-
|
|
467
|
-
## Support
|
|
468
|
-
|
|
469
|
-
- **Documentation**: [FAQ](./docs/FAQ.md) and skill READMEs
|
|
470
|
-
- **Issues**: [GitHub Issues](https://github.com/Felo-Inc/felo-skills/issues)
|
|
471
|
-
- **Email**: support@felo.ai
|
|
472
|
-
|
|
473
|
-
---
|
|
474
|
-
|
|
475
|
-
## Version history
|
|
214
|
+
We welcome contributions — report bugs, improve docs, or add new skills. Run tests with `npm test`.
|
|
476
215
|
|
|
477
|
-
|
|
216
|
+
**[Contributing guide →](./CONTRIBUTING.md)**
|
|
478
217
|
|
|
479
218
|
---
|
|
480
219
|
|
|
481
220
|
## License
|
|
482
221
|
|
|
483
|
-
MIT
|
|
222
|
+
MIT — see [LICENSE](./felo-search/LICENSE) for details.
|
|
484
223
|
|
|
485
224
|
---
|
|
486
225
|
|
|
487
|
-
Made with ❤️ by the Felo team
|
|
226
|
+
<p align="center">Made with ❤️ by the <a href="https://felo.ai">Felo</a> team</p>
|
|
@@ -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.
|