focalapi-cli 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,190 @@
+<div align="center">
+
+# focalapi-cli
+
+**给你的 AI Agent 赋予 focalapi 的全部模型能力**
+
+[![npm](https://img.shields.io/npm/v/focalapi-cli?color=brightgreen&label=npm)](https://www.npmjs.com/package/focalapi-cli)
+[![license](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
+[![node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
+
+focalapi 的对话、图像生成、视频生成、联网搜索、音频、向量、Rerank、用量查询能力，都可以通过 focalapi CLI + Skills 交给 Claude Code、Codex、OpenCode、Hermes 等本地 Agent 调用。
+
+```shell
+npm i -g focalapi-cli
+```
+
+</div>
+
+---
+
+## focalapi-cli 能做什么
+
+让你的 AI Agent 具备这些 focalapi 能力，并能在复杂任务中组合调用：
+
+- **模型调用**：文本对话、多模态输入（图片理解）、流式输出、管道输入
+- **图片 / 视频生成**：文生图、文生视频，产物自动下载到本地；视频任务支持异步编排
+- **联网搜索**：`/v1/alpha/search`，给 Agent 接上实时信息
+- **音频**：语音转写（transcribe）、文字转语音（speech）
+- **向量 / 重排**：embeddings 与 rerank，检索链路两件套
+- **Agent 接入**：`focalapi connect` 把内置 Skills 装进本机 Agent，Agent 即刻学会调用 focalapi
+- **治理闭环**：`usage` 额度用量、`doctor` 只读诊断（用免费演练模型做端到端自检，不花额度）
+
+## 为什么需要 focalapi-cli
+
+focalapi-cli 不是让你记住更多命令，而是把 focalapi 的模型能力变成 Agent 可以调用的工具箱。
+
+```text
+接入链路:
+安装 CLI -> 登录（sk- key）-> connect 注入 Agent Skills -> Agent 自然语言调用能力
+
+调用链路（Agent 视角）:
+models list 选模型
+  -> chat / gen / search / embed / rerank 调用
+  -> 产物落盘（图像/视频/音频）
+  -> usage 看额度，doctor 做诊断
+```
+
+## 安装与初始化
+
+```shell
+# 1. 安装 CLI（Node.js >= 18）
+npm i -g focalapi-cli
+focalapi --version
+
+# 2. 登录（Key 在 https://focalapi.com/console/token 创建）
+focalapi auth login --key sk-xxxx
+
+# 3. 自检（使用免费演练模型 focal-rehearsal-chat，不消耗额度）
+focalapi doctor
+
+# 4. 把 focalapi Skills 同步到本机 Agent
+focalapi connect install
+```
+
+无终端交互的环境（CI、Agent 沙箱）用环境变量即可：
+
+```shell
+export FOCALAPI_API_KEY=sk-xxxx
+# 私有化部署时：export FOCALAPI_BASE_URL=https://你的域名
+```
+
+## 常用任务
+
+### 对话与多模态
+
+```shell
+focalapi chat "用一句话总结 RAG 的核心思想" -m focal-rehearsal-chat
+
+cat report.md | focalapi chat -m <model> --system "你是严谨的技术编辑"
+
+focalapi chat "描述这张图片" -m <多模态模型> --input @photo.jpg
+```
+
+### 生成图片 / 视频
+
+```shell
+focalapi gen image "未来城市海报" -m <图像模型> --size 1024x1024 -o ./out
+
+# 视频：默认等待完成并下载；异步编排用 --no-wait
+focalapi gen video "海浪拍打礁石" -m <视频模型> --seconds 5
+focalapi gen video "海浪拍打礁石" -m <视频模型> --no-wait --json   # 拿 task_id
+focalapi task status <task_id> --json
+focalapi task download <task_id> -o ./out
+```
+
+### 搜索 / 向量 / 重排 / 音频
+
+```shell
+focalapi search "过去7天 AI 行业新闻" -m <搜索模型> --json
+focalapi embed "待编码文本" -m <向量模型> --json
+focalapi rerank -m <rerank模型> --query "问题" --docs @docs.json
+focalapi audio transcribe meeting.mp3 -m <转写模型>
+focalapi audio speech "大家好" -m <TTS模型> -o hello.mp3
+```
+
+### 额度与诊断
+
+```shell
+focalapi usage          # 令牌额度 + 本周期账单用量
+focalapi auth status    # Key 有效性、来源、过期时间
+focalapi doctor         # 全链路只读诊断，任何调用失败先跑它
+```
+
+## Agent 接入（connect）
+
+```shell
+focalapi connect list                 # 探测本机 Agent（Claude Code / Codex / OpenCode / Hermes）
+focalapi connect install              # 向全部检测到的 Agent 安装 skills
+focalapi connect install claude-code  # 只装指定 Agent
+focalapi connect uninstall            # 按 manifest 精确卸载，不碰其他文件
+```
+
+`connect install` 把本仓库 [`skills/`](./skills) 下的技能包复制到各 Agent 的技能目录，并打印 provider 配置指引（把 Agent 的模型后端指向 focalapi）。技能装入后重启 Agent 会话，即可用自然语言驱动，例如「用 focalapi 画一张赛博朋克海报」。
+
+## 面向 Agent 的设计约定
+
+- 所有命令支持 `--json`：stdout 只输出 JSON（诊断走 stderr），可直接 `| jq`
+- 非 TTY 环境自动禁用交互与动画，CI / 沙箱可无人值守运行
+- 错误统一为 `{error: {code, message, hint}}` + 非零退出码
+- API Key 绝不完整打印（一律 `sk-***尾4位` 脱敏）
+
+## 命令入口
+
+| 任务 | 命令 |
+|---|---|
+| 登录 / 状态 / 登出 | `focalapi auth login / status / logout` |
+| 对话和多模态推理 | `focalapi chat` |
+| 图片 / 视频生成 | `focalapi gen image / gen video` |
+| 任务查询与产物下载 | `focalapi task status / download` |
+| 联网搜索 | `focalapi search` |
+| 语音转写 / 合成 | `focalapi audio transcribe / speech` |
+| 向量化 / 重排序 | `focalapi embed / rerank` |
+| 模型查询 | `focalapi models list / get` |
+| 额度用量 | `focalapi usage` |
+| 诊断排障 | `focalapi doctor` |
+| Agent 接入 | `focalapi connect list / install / uninstall` |
+| 版本与更新检查 | `focalapi version / update` |
+| 原始只读 API 请求 | `focalapi request get /v1/models` |
+
+每个命令都自带帮助：`focalapi <command> --help`。
+
+### 原始只读请求
+
+优先使用语义化命令（如 `models`、`chat`、`gen`）。当服务新增尚未封装的读取端点时，可使用：
+
+```shell
+focalapi request get /v1/models --json
+focalapi request head /v1/models --json
+```
+
+该入口只接受站内路径与 `GET` / `HEAD`，不会隐藏任何写入操作。`--json` 时高阶命令通常直通上游响应；`request` 固定返回 `{ method, path, status, content_type, data }` 信封，错误仍为 `{ error: { code, message, hint? } }`，且不会输出完整 API Key。
+
+## 配置
+
+- 配置文件：`~/.focalapi/config.json`（权限 600），支持多 profile（`--profile`）
+- 环境变量：`FOCALAPI_API_KEY`、`FOCALAPI_BASE_URL`、`FOCALAPI_MODEL`、`FOCALAPI_CONFIG_DIR`
+- 优先级：命令行 flag > 环境变量 > 配置文件
+
+## 本地 e2e 验证清单（需要真实 Key）
+
+```shell
+focalapi auth login --key sk-xxxx
+focalapi doctor                                        # 全 ✓
+focalapi chat "你好" -m focal-rehearsal-chat            # 免费演练模型
+focalapi gen image "测试图" -m <图像模型> -o ./out
+focalapi gen video "测试视频" -m <视频模型> --no-wait --json
+focalapi task download <task_id>
+focalapi connect install && focalapi connect uninstall # 幂等且清理干净
+```
+
+## 链接
+
+- focalapi：<https://focalapi.com>
+- Gitee：<https://gitee.com/xnn-ai/focalapi-cli>
+- npm：<https://www.npmjs.com/package/focalapi-cli>
+- 内置 Skills：[`./skills`](./skills)
+
+## License
+
+[Apache-2.0](./LICENSE)