felo-ai 0.2.3 → 0.2.4

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.
Files changed (3) hide show
  1. package/README.en.md +28 -9
  2. package/README.md +37 -18
  3. package/package.json +2 -2
package/README.en.md CHANGED
@@ -21,12 +21,9 @@ Search the web for up-to-date information and get AI-synthesized answers. Ideal
21
21
  - **Claude Code**: After installing the skill, it triggers automatically, or type `/felo-ai your question`
22
22
  - **Examples**: `felo search "Tokyo weather"`, `felo search "React 19 new features" --verbose`
23
23
 
24
- ### Capability 2: Generate PPT
24
+ ### Capability 2: Generate PPT (Felo Slides)
25
25
 
26
- Describe a topic in one sentence and Felo generates a slideshow. The job runs in the cloud; when done, you get an **online document link** to open in your browser.
27
-
28
- - **Terminal**: `felo slides "your topic or description"`
29
- - **Examples**: `felo slides "Felo product intro, 3 slides"`, `felo slides "Introduction to React" --poll-timeout 300`
26
+ Terminal: `felo slides "your topic"`. In Claude Code: install `npx @claude/skills add felo-slides`, then `/felo-slides your topic`. You get an online document link when done. Examples: `felo slides "Felo product intro, 3 slides"`, `felo slides "Introduction to React"`.
30
27
 
31
28
  ---
32
29
 
@@ -62,17 +59,39 @@ Get your API key at [felo.ai](https://felo.ai) (Settings → API Keys).
62
59
  | `felo config set FELO_API_KEY <key>` | Save API key |
63
60
  | `felo config get/list/path/unset` | View / list / path / remove config |
64
61
 
62
+ ### Examples
63
+
64
+ **Search**
65
+
66
+ ```bash
67
+ felo search "Tokyo weather"
68
+ felo search "MacBook Air M3 price"
69
+ felo search "React 19 new features" --verbose
70
+ npx felo-ai search "Tokyo weather"
71
+ ```
72
+
73
+ **Slides**
74
+
75
+ ```bash
76
+ felo slides "Felo product intro, 3 slides"
77
+ felo slides "Introduction to React"
78
+ felo slides "Q4 2024 business review, 10 pages" --poll-timeout 300
79
+ npx felo-ai slides "Tokyo travel guide, 5 slides"
80
+ ```
81
+
65
82
  ---
66
83
 
67
- ## Claude Code Skill
84
+ ## Claude Code Skills
68
85
 
69
- Install the skill:
86
+ **Search** — Install and use real-time search:
70
87
 
71
88
  ```bash
72
- npx @claude/skills add felo-ai
89
+ npx @claude/skills add felo-search
73
90
  ```
74
91
 
75
- After setting `FELO_API_KEY`, ask Claude things like “What’s the weather in Tokyo today?” or “React 19 new features and search will trigger automatically. PPT generation is available only via the terminal with `felo slides`.
92
+ After setting `FELO_API_KEY`, ask Claude things like “What’s the weather in Tokyo today?” or “React 19 new features”; the search skill triggers automatically (or use `/felo-search your question`).
93
+
94
+ **Slides (PPT)** — `npx @claude/skills add felo-slides`, then `/felo-slides your topic`. Same `FELO_API_KEY`. [Details →](./felo-slides/README.md)
76
95
 
77
96
  ---
78
97
 
package/README.md CHANGED
@@ -1,30 +1,27 @@
1
- # Felo Skills for Claude Code
1
+ # Felo AI CLI
2
2
 
3
- **Ask anything. Get current answers powered by AI.**
3
+ **Ask anything. Get current answers. Generate slides from a prompt.**
4
4
 
5
- Real-time web search powered by Felo AI. Works in Chinese, English, Japanese, and Korean.
5
+ [npm package: **felo-ai**](https://www.npmjs.com/package/felo-ai) — Real-time search and PPT generation from the terminal. Also works as Claude Code skills. Supports Chinese, English, Japanese, and Korean.
6
6
 
7
- [![Setup Time](https://img.shields.io/badge/setup-2%20minutes-blue)]() [![License](https://img.shields.io/badge/license-MIT-green)]()
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)]()
8
8
 
9
9
  ---
10
10
 
11
- ## Felo CLI (Terminal)
12
-
13
- Use Felo search from the terminal without opening Claude Code.
14
-
15
- ### Install
11
+ ## Install (CLI)
16
12
 
17
13
  ```bash
18
- npm install -g felo-search
14
+ npm install -g felo-ai
19
15
  ```
20
16
 
21
- Or run without installing (uses latest published version):
17
+ Run without installing:
22
18
 
23
19
  ```bash
24
- npx felo-search search "Tokyo weather"
20
+ npx felo-ai search "Tokyo weather"
21
+ npx felo-ai slides "Introduction to React, 5 slides"
25
22
  ```
26
23
 
27
- After install, the command is `felo` (from the package name `felo-search`).
24
+ After install, the command is `felo` (package name: **felo-ai**).
28
25
 
29
26
  ### Configure API key
30
27
 
@@ -53,32 +50,47 @@ Get your API key from [felo.ai](https://felo.ai) (Settings → API Keys). Enviro
53
50
  | Command | Description |
54
51
  | ------------------------------------ | ----------------------------------------------------- |
55
52
  | `felo search "<query>"` | Search for current info (weather, news, prices, etc.) |
53
+ | `felo slides "<prompt>"` | Generate PPT; returns link when done |
56
54
  | `felo config set FELO_API_KEY <key>` | Save API key to config |
57
55
  | `felo config get FELO_API_KEY` | Print stored key |
58
56
  | `felo config list` | List config keys |
59
57
  | `felo config path` | Show config file path |
60
- | `felo summarize` / `felo translate` | Planned; use `felo search` for now |
61
58
 
62
59
  ### Examples
63
60
 
61
+ **Search**
62
+
64
63
  ```bash
65
64
  felo search "Tokyo weather"
66
65
  felo search "MacBook Air M3 price"
67
66
  felo search "React 19 new features" --verbose
68
67
  felo search "Hangzhou tomorrow weather" --json
69
- npx felo-search search "Tokyo weather"
68
+ npx felo-ai search "Tokyo weather"
69
+ ```
70
+
71
+ **Slides**
72
+
73
+ ```bash
74
+ felo slides "Felo product intro, 3 slides"
75
+ felo slides "Introduction to React"
76
+ felo slides "Q4 2024 business review, 10 pages" --poll-timeout 300
77
+ npx felo-ai slides "Tokyo travel guide, 5 slides"
70
78
  ```
71
79
 
72
80
  ### CLI FAQ
73
81
 
74
82
  - **Key not found?** Run `felo config set FELO_API_KEY <key>` or set the `FELO_API_KEY` environment variable.
75
83
  - **Request timeout?** Use `felo search "query" --timeout 120` (default 60 seconds). 5xx errors are retried automatically with backoff.
84
+ - **Slides taking long?** Use `felo slides "topic" --poll-timeout 300` (default 1200s) to limit wait.
76
85
  - **Where is config stored?** Run `felo config path` to see the file (e.g. `~/.felo/config.json`).
77
- - **Streaming?** Not yet; when the Felo API supports streaming, the CLI can be updated to stream output.
78
86
 
79
87
  ---
80
88
 
81
- ## Quick Start (Claude Code Skill)
89
+ ## Claude Code Skills (optional)
90
+
91
+ 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.
92
+
93
+ ### Quick Start (Search skill)
82
94
 
83
95
  Install the skill:
84
96
 
@@ -110,6 +122,8 @@ Ask Claude: "What's the weather in Tokyo today?"
110
122
 
111
123
  **You're done!** The skill triggers automatically for any question needing current information.
112
124
 
125
+ **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).
126
+
113
127
  ---
114
128
 
115
129
  ## Usage Examples
@@ -284,6 +298,10 @@ Real-time web search with AI-generated answers.
284
298
 
285
299
  **[View skill documentation →](./felo-search/)**
286
300
 
301
+ ### felo-slides
302
+
303
+ Generate PPT: in terminal use `felo slides "your topic"`, in Claude Code use `/felo-slides your topic`. **[View skill documentation →](./felo-slides/)**
304
+
287
305
  ---
288
306
 
289
307
  ## Contributing
@@ -302,6 +320,7 @@ Run CLI tests: `npm test`
302
320
 
303
321
  ## Links
304
322
 
323
+ - **[npm: felo-ai](https://www.npmjs.com/package/felo-ai)** — CLI package
305
324
  - **[Felo Open Platform](https://openapi.felo.ai/docs/)** — Get your API key
306
325
  - **[API Documentation](https://openapi.felo.ai/docs/api-reference/v2/chat.html)** — API reference
307
326
  - **[Claude Code](https://claude.ai/code)** — AI assistant CLI
@@ -321,7 +340,7 @@ Run CLI tests: `npm test`
321
340
 
322
341
  ## License
323
342
 
324
- MIT License — see [LICENSE](./felo-search/LICENSE) for details.
343
+ MIT — see [LICENSE](./felo-search/LICENSE) in the repo for details.
325
344
 
326
345
  ---
327
346
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "felo-ai",
3
- "version": "0.2.3",
4
- "description": "Felo AI CLI - real-time search from the terminal",
3
+ "version": "0.2.4",
4
+ "description": "Felo AI CLI - real-time search and PPT generation from the terminal",
5
5
  "type": "module",
6
6
  "main": "src/cli.js",
7
7
  "bin": {