felo-ai 0.2.0

package/README.md

@@ -0,0 +1,328 @@
+# Felo AI
+
+**Ask anything. Get current answers powered by AI.**
+
+Felo AI provides a terminal CLI and Claude Code skill, with support for English, Chinese (Simplified & Traditional), Japanese, and Korean.
+
+[![Setup Time](https://img.shields.io/badge/setup-2%20minutes-blue)]() [![License](https://img.shields.io/badge/license-MIT-green)]()
+
+**Other languages:** [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · [한국어](README.ko.md) · [繁體中文](README.zh-TW.md)
+
+---
+
+## Two Core Capabilities
+
+Felo AI offers two main features: **Real-time Search** and **PPT Generation**. Use them via the CLI in your terminal, or in Claude Code via the skill (search can trigger automatically).
+
+### Capability 1: Real-time Search
+
+Search the web for up-to-date information and get AI-synthesized answers. Ideal for weather, news, prices, documentation, tech updates, and any question that needs “right now” information.
+
+- **Multi-language**: Ask in your preferred language.
+- **Terminal**: `felo search "your question"`
+- **Claude Code**: After installing the skill, it triggers automatically, or type `/felo-ai your question`
+- **Examples**: `felo search "Tokyo weather"`, `felo search "React 19 new features" --verbose`
+
+### Capability 2: Generate PPT
+
+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.
+
+- **Terminal**: `felo slides "your topic or description"`
+- **Options**: `--verbose` for polling status, `--json` for raw JSON (`task_id`, `live_doc_url`).
+- **Examples**: `felo slides "Felo product intro, 3 slides"`, `felo slides "Introduction to React"`, `felo slides "Quarterly review" --poll-timeout 300`
+
+---
+
+## Felo CLI (Terminal)
+
+Use Felo from the terminal without opening Claude Code.
+
+### Install
+
+```bash
+npm install -g felo-ai
+```
+
+Run without installing (latest published version):
+
+```bash
+npx felo-ai search "Tokyo weather"
+```
+
+After install, the command is `felo` (from package name `felo-ai`).
+
+### Configure API key
+
+**Option 1: Persist with config (recommended)**
+
+```bash
+felo config set FELO_API_KEY your-api-key-here
+```
+
+The key is stored in `~/.felo/config.json` (Windows: `%USERPROFILE%\.felo\config.json`). You only need to set it once.
+
+**Option 2: Environment variable**
+
+```bash
+# Linux/macOS
+export FELO_API_KEY="your-api-key-here"
+
+# Windows (PowerShell)
+$env:FELO_API_KEY="your-api-key-here"
+```
+
+Get your API key from [felo.ai](https://felo.ai) (Settings → API Keys). Environment variable overrides config if both are set.
+
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| `felo search "<query>"` | **Real-time search** — weather, news, prices, docs, etc. |
+| `felo slides "<prompt>"` | **Generate PPT** — outputs online doc link when done |
+| `felo config set FELO_API_KEY <key>` | Save API key (recommended before first use) |
+| `felo config get/list/path/unset` | View, list, path, or remove config |
+
+### Examples
+
+```bash
+felo search "Tokyo weather"
+felo search "MacBook Air M3 price"
+felo search "React 19 new features" --verbose
+felo search "Hangzhou tomorrow weather" --json
+npx felo-ai search "Tokyo weather"
+```
+
+### CLI FAQ
+
+- **Key not found?** Run `felo config set FELO_API_KEY <key>` or set the `FELO_API_KEY` environment variable.
+- **Request timeout?** Use `felo search "query" --timeout 120` (default 60 seconds). 5xx errors are retried automatically with backoff.
+- **Where is config stored?** Run `felo config path` to see the file (e.g. `~/.felo/config.json`).
+- **Streaming?** Not yet; when the Felo API supports streaming, the CLI can be updated to stream output.
+
+---
+
+## Quick Start (Claude Code Skill)
+
+Install the skill:
+
+```bash
+npx @claude/skills add felo-ai
+```
+
+Get your API key from [felo.ai](https://felo.ai) (Settings → API Keys), then configure:
+
+**Linux/macOS:**
+```bash
+export FELO_API_KEY="your-api-key-here"
+# Add to ~/.bashrc or ~/.zshrc for persistence
+```
+
+**Windows (PowerShell):**
+```powershell
+$env:FELO_API_KEY="your-api-key-here"
+# For persistence, add to system environment variables
+```
+
+Test it:
+```
+Ask Claude: "What's the weather in Tokyo today?"
+```
+
+**You're done!** The skill triggers automatically for any question needing current information.
+
+---
+
+## Usage Examples
+
+### Daily life
+
+**Weather**
+```
+You: What's the weather in Tokyo today?
+Claude: [Current temperature, conditions, forecast]
+```
+
+**Restaurants & food**
+```
+You: Best ramen in Osaka
+Claude: [Top-rated ramen shops with addresses, ratings, reviews]
+```
+
+**Shopping & prices**
+```
+You: iPhone 15 Pro price comparison
+Claude: [Prices from different retailers with links]
+```
+
+**Travel**
+```
+You: Things to do in Kyoto this weekend
+Claude: [Events, attractions, seasonal activities]
+```
+
+### Developer scenarios
+
+**Latest documentation**
+```
+You: React 19 new features
+Claude: [Latest React 19 features with official docs links]
+```
+
+**Library comparison**
+```
+You: Vite vs Webpack 2024 comparison
+Claude: [Performance, features, use cases comparison]
+```
+
+**Tech trends**
+```
+You: Latest AI developments January 2026
+Claude: [Recent AI breakthroughs, company announcements]
+```
+
+### Multi-language queries
+
+Works in Chinese (Simplified & Traditional), Japanese, Korean, and English. Ask in any language, get answers in that language.
+
+**[See 40+ more examples →](./docs/EXAMPLES.md)**
+
+---
+
+## Installation details
+
+### Prerequisites
+
+- [Claude Code](https://claude.ai/code) CLI installed
+- Node.js (for npx)
+- Internet connection
+
+### Manual installation
+
+If quick install doesn’t work:
+
+1. Clone this repository:
+   ```bash
+   git clone https://github.com/Felo-Inc/felo-skills.git
+   cd felo-skills
+   ```
+
+2. Copy to Claude Code skills directory:
+   - **Linux/macOS:** `~/.claude/skills/`
+   - **Windows:** `C:\Users\<YourUsername>\.claude\skills\`
+
+   ```bash
+   # Linux/macOS
+   cp -r felo-search ~/.claude/skills/
+
+   # Windows (PowerShell)
+   Copy-Item -Recurse felo-search "$env:USERPROFILE\.claude\skills\"
+   ```
+
+3. Get API key from [felo.ai](https://felo.ai) (Settings → API Keys)
+
+4. Set environment variable (see Quick Start)
+
+5. Restart Claude Code: `claude restart`
+
+### Verify installation
+
+```bash
+claude skills list
+```
+
+You should see `felo-ai` or `felo-search` in the output.
+
+Test: ask Claude *"Latest news about quantum computing"*. If you see an AI-generated answer, it’s working.
+
+---
+
+## FAQ
+
+### Q: Skill not triggering automatically?
+
+**A:** The skill triggers for questions needing current info (weather, news, prices, etc.). For manual trigger, use `/felo-ai your query here`.
+
+### Q: "FELO_API_KEY not set" error?
+
+**A:** Set the environment variable (see Quick Start), then restart Claude Code.
+
+### Q: Environment variable not persisting?
+
+**A:** Add to your shell profile: **bash** `~/.bashrc`, **zsh** `~/.zshrc`, **Windows** system environment variables.
+
+### Q: "INVALID_API_KEY" error?
+
+**A:** Your API key is incorrect or revoked. Generate a new one at [felo.ai](https://felo.ai) (Settings → API Keys).
+
+### Q: Does it work in Chinese/Japanese/Korean?
+
+**A:** Yes. Multi-language queries are supported; ask in any language.
+
+### Q: Rate limits?
+
+**A:** Check your Felo account tier at [felo.ai](https://felo.ai). Free tier available.
+
+### Q: Can I use it offline?
+
+**A:** No, it requires an internet connection to the Felo API.
+
+### Q: How fast are responses?
+
+**A:** Typically 2–5 seconds depending on query complexity.
+
+**[Full FAQ →](./docs/FAQ.md)**
+
+---
+
+## Claude Code skill (summary)
+
+With `felo-ai` installed, **real-time search** runs as a skill: when you ask about weather, news, prices, or latest docs, Felo search is triggered and returns an answer. You can also type `/felo-ai your question` to trigger it manually.
+
+**Typical triggers:** current events, weather/prices/reviews, places (restaurants, attractions), latest tech docs and trends, product comparisons, and questions with words like “latest”, “recent”, “best”, “how to”.
+
+PPT generation is only available in the terminal via `felo slides`.
+
+**[Search skill details →](./felo-search/)**
+
+---
+
+## Contributing
+
+We welcome contributions:
+
+- Report bugs or request features
+- Improve documentation
+- Add new skills
+
+Run CLI tests: `npm test`
+
+**[Contributing guide →](./CONTRIBUTING.md)**
+
+---
+
+## Links
+
+- **[Felo Open Platform](https://openapi.felo.ai/docs/)** — Get your API key
+- **[API Documentation](https://openapi.felo.ai/docs/api-reference/v2/chat.html)** — API reference
+- **[Claude Code](https://claude.ai/code)** — AI assistant CLI
+- **[Full examples](./docs/EXAMPLES.md)** — 40+ usage examples
+- **[FAQ](./docs/FAQ.md)** — Troubleshooting
+- **[GitHub Issues](https://github.com/Felo-Inc/felo-skills/issues)** — Report bugs
+
+---
+
+## Support
+
+- **Documentation**: [FAQ](./docs/FAQ.md) and skill READMEs
+- **Issues**: [GitHub Issues](https://github.com/Felo-Inc/felo-skills/issues)
+- **Email**: support@felo.ai
+
+---
+
+## License
+
+MIT License — see [LICENSE](./felo-search/LICENSE) for details.
+
+---
+
+Made with ❤️ by the Felo team

package/README.zh-CN.md

@@ -0,0 +1,87 @@
+# Felo AI
+
+**随时提问，用 AI 获取当下最新答案。**
+
+Felo AI 提供终端 CLI 与 Claude Code 技能，支持简体中文、英文、日文、韩文、繁体中文等多语言。
+
+[![License](https://img.shields.io/badge/license-MIT-green)]()
+
+---
+
+## 两大能力
+
+Felo AI 提供两个核心能力：**实时搜索** 与 **PPT 生成**。可在终端用 CLI 使用，也可在 Claude Code 中通过技能使用（搜索支持自动触发）。
+
+### 能力一：实时搜索
+
+联网搜索最新信息，由 AI 整合成可直接使用的回答。适合查天气、新闻、价格、文档、技术动态等一切需要「当下」信息的场景。
+
+- **支持多语言**：用你习惯的语言提问即可。
+- **终端**：`felo search "你的问题"`
+- **Claude Code**：安装技能后自动触发，或输入 `/felo-ai 你的问题`
+- **示例**：`felo search "杭州明天天气"`、`felo search "React 19 new features" --verbose`
+
+### 能力二：生成 PPT
+
+根据一句描述或主题，自动生成 PPT。任务在云端执行，完成后返回**在线文档链接**，浏览器打开即可查看/编辑。
+
+- **终端**：`felo slides "你的主题或描述"`
+- **示例**：`felo slides "Felo 产品介绍，3 页"`、`felo slides "Introduction to React" --poll-timeout 300`
+
+---
+
+## 安装与配置
+
+### 安装 CLI
+
+```bash
+npm install -g felo-ai
+```
+
+不安装直接运行：`npx felo-ai search "东京天气"`  
+安装后命令为 `felo`。
+
+### 配置 API Key
+
+推荐（持久保存）：
+
+```bash
+felo config set FELO_API_KEY your-api-key-here
+```
+
+或设置环境变量：`export FELO_API_KEY="your-api-key-here"`（Linux/macOS），`$env:FELO_API_KEY="your-api-key-here"`（Windows PowerShell）。
+
+API Key 请在 [felo.ai](https://felo.ai)（设置 → API Keys）获取。
+
+### 命令一览
+
+| 命令 | 说明 |
+|------|------|
+| `felo search "<query>"` | 实时搜索 |
+| `felo slides "<prompt>"` | 生成 PPT |
+| `felo config set FELO_API_KEY <key>` | 保存 API Key |
+| `felo config get/list/path/unset` | 查看/列出/定位/删除配置 |
+
+---
+
+## Claude Code 技能
+
+安装技能：
+
+```bash
+npx @claude/skills add felo-ai
+```
+
+配置 `FELO_API_KEY` 后，在 Claude Code 中问「东京今天天气」「React 19 新特性」等问题会自动触发搜索。PPT 生成目前仅支持终端 `felo slides`。
+
+---
+
+## 链接
+
+- [Felo 开放平台](https://openapi.felo.ai/docs/) — 获取 API Key
+- [API 文档](https://openapi.felo.ai/docs/api-reference/v2/chat.html)
+- [更多示例](./docs/EXAMPLES.md) | [FAQ](./docs/FAQ.md) | [GitHub Issues](https://github.com/Felo-Inc/felo-skills/issues)
+
+---
+
+**其他语言 / Other languages:** [English](README.en.md) | [日本語](README.ja.md) | [한국어](README.ko.md) | [繁體中文](README.zh-TW.md)

package/README.zh-TW.md

@@ -0,0 +1,87 @@
+# Felo AI
+
+**隨時提問，用 AI 取得當下最新答案。**
+
+Felo AI 提供終端 CLI 與 Claude Code 技能，支援繁體中文、簡體中文、英文、日文、韓文等多語言。
+
+[![License](https://img.shields.io/badge/license-MIT-green)]()
+
+---
+
+## 兩大能力
+
+Felo AI 提供兩個核心能力：**即時搜尋** 與 **PPT 生成**。可在終端用 CLI 使用，也可在 Claude Code 中透過技能使用（搜尋支援自動觸發）。
+
+### 能力一：即時搜尋
+
+連網搜尋最新資訊，由 AI 整合成可直接使用的回答。適合查天氣、新聞、價格、文件、技術動態等一切需要「當下」資訊的場景。
+
+- **支援多語言**：用你習慣的語言提問即可。
+- **終端**：`felo search "你的問題"`
+- **Claude Code**：安裝技能後自動觸發，或輸入 `/felo-ai 你的問題`
+- **範例**：`felo search "台北明天天氣"`、`felo search "React 19 new features" --verbose`
+
+### 能力二：生成 PPT
+
+根據一句描述或主題，自動生成一份 PPT。任務在雲端執行，完成後回傳**線上文件連結**，可直接在瀏覽器開啟檢視/編輯。
+
+- **終端**：`felo slides "你的主題或描述"`
+- **範例**：`felo slides "Felo 產品介紹，3 頁"`、`felo slides "Introduction to React" --poll-timeout 300`
+
+---
+
+## 安裝與設定
+
+### 安裝 CLI
+
+```bash
+npm install -g felo-ai
+```
+
+不安裝直接執行：`npx felo-ai search "東京天氣"`  
+安裝後指令為 `felo`。
+
+### 設定 API Key
+
+建議（持久保存）：
+
+```bash
+felo config set FELO_API_KEY your-api-key-here
+```
+
+或設定環境變數：`export FELO_API_KEY="your-api-key-here"`（Linux/macOS），`$env:FELO_API_KEY="your-api-key-here"`（Windows PowerShell）。
+
+API Key 請至 [felo.ai](https://felo.ai)（設定 → API Keys）取得。
+
+### 指令一覽
+
+| 指令 | 說明 |
+|------|------|
+| `felo search "<query>"` | 即時搜尋 |
+| `felo slides "<prompt>"` | 生成 PPT |
+| `felo config set FELO_API_KEY <key>` | 儲存 API Key |
+| `felo config get/list/path/unset` | 檢視/列出/路徑/刪除設定 |
+
+---
+
+## Claude Code 技能
+
+安裝技能：
+
+```bash
+npx @claude/skills add felo-ai
+```
+
+設定 `FELO_API_KEY` 後，在 Claude Code 中詢問「東京今天天氣」「React 19 新特性」等問題會自動觸發搜尋。PPT 生成目前僅支援終端 `felo slides`。
+
+---
+
+## 連結
+
+- [Felo 開放平台](https://openapi.felo.ai/docs/) — 取得 API Key
+- [API 文件](https://openapi.felo.ai/docs/api-reference/v2/chat.html)
+- [更多範例](./docs/EXAMPLES.md) | [FAQ](./docs/FAQ.md) | [GitHub Issues](https://github.com/Felo-Inc/felo-skills/issues)
+
+---
+
+**其他語言 / Other languages:** [简体中文](README.zh-CN.md) | [English](README.en.md) | [日本語](README.ja.md) | [한국어](README.ko.md)