@felan-ai/felan

中文文档
0.39.6发布于 2026/11/13MITTypeScriptES Module构建来源已验证近 30 天下载 7080

Felan Code:一种为成本效益高,可核查的软件工作而建造的开源可移植模型编码剂

中文使用文档
文档目录10 节
  1. 配置服务
  2. 要求和快速启动
  3. Azure 提供者迁移
  4. 国 际
  5. 守护进程生命周期
  6. 原生非加太语 v1
  7. Zed 自定义代理
  8. 地方国家和政策
  9. Canonic 用户文档
  10. 发展

Felan 代码

当地、无账户、可采用型号编码剂,以具有成本效益, 可核查的软件工作 @felan-ai/agent-core费兰拥有的TUI 还有Pi的会话时间.

npx @felan-ai/felan

包裹暴露 felan 二进制并拥有CLI/TUI,ACP,无头客户端, 本地服务提供商和默认 host.json。它安装精确 @felan-ai/daemon 依赖性。 守护者拥有承认权, 犬类储存和 执行寿命; 本地提供者提供设置、 证书和运行时间. 可移植特性行为在 @felan-ai/ext-* 软件包.

所有会话执行都通过准确安装的守护进程包; resolveInstalledDaemonEntrypoint() 不假设发射时间为Cwd。 前者 配置导出被删除。 供应商使用 @felan-ai/daemon/provider 财务报告和审定财务报表 @felan-ai/daemon/session-runtime协调断开释放 Felan 0.30.0,守护进程0.1.0和特工Core 0.13.0.

配置服务

过 --host-config /absolute/path/host.json 选择可信任的明文 配置 。 否则,发射器使用 host.json 在代理目录中, 然后它的包式默认值。 安装管理中的供应商决心 软件包,从项目或配置目录中选择。 提供者更改 需要重新启动守护进程 。 恢复会话与当前 配置,如0.28.3.

程序消费者使用客户 API: runCli, (中文(简体) ), runDaemonFelan, (中文(简体) ), runLocalFelanHeadless, (中文(简体) ), SessionClient, (中文(简体) ), newRequestId,守护进程目标 客户端-配置路径帮助器,版本,和出入口解析. 运行时间, 存储、 模型、 设置、 分类器、 和子代理主机构造器已不再 导出. CliDependencies.openSession 和无头主机运行时间选项 删除; 通过守护进程服务运行工作 。 没有进程 倒计时.

[大 本地主机使用当前用户的文件系统并处理权限. 这个 这不是沙盒.

Felan Code使用Pi 1.5.2作为其代理,提供商,以及TUI运行时间. Pi的型号 通过该运行时间可以获得目录和终端颜色检测. Pi-native MCP,codemode,和工具搜索不自动被装入Felan中: MCP 仍然是在其中描述的清晰的 OAuth 唯一 HTTP 网关 远程 MCP。 。 。 . Pi的本地 stdio 服务器,无记名符号,自定义头条,以及直接 MCP 工具 felan的内置网关不支持.

要求和快速启动

Azure 提供者迁移

Pi 1.0.3 将 Azure 供应商从 azure-openai-responses 改为 azure。 。 。 . 更新在 auth.json 财务报告和审定财务报表 models.json,并更改任何 defaultProvider, (中文(简体) ), enabledModels 模式,以及 modelThinkingLevels 键在 settings.json 改为 azure。恢复时, Pi 不重复使用旧的提供者ID 因此,一个更古老的Azure会话可能会回到另一个模式,不会 重新使用它的快速缓存 。 Azure 环境变量,例如 AZURE_OPENAI_API_KEY 不变; 模型 API 标识符 azure-openai-responses 也还是 azure模型定义使用.

Felan Code支持22.19.0节点或更新. 仓库开发和使用 节点.js 22.23.4 有pnpm 9.15.5.

原生 Windows x64 和 arm64 使用相同的守护进程支持的 TUI, ACP 和 无头 客户。 Git Bash 提供 POSIX 依赖的工具; WSL 是替代的 Linux 环境,而不是自动倒置。 可选的抚养限额列出 内 运行时间依赖关系。 。 。 . Windows 守护进程 CI 使用高端管理员账户,而不覆盖一个 标准非管理员账户或交互式控制台-窗口行为。 见 土著所有权。 。 。 .

felan
/login

运行当前初始提示或继续最近的会话 目录 :

felan "inspect this project"
felan --continue
felan --mode text "summarize the current work"
felan --mode json --provider openai --model gpt-5.6-sol --thinking high "run the tests"

国 际

felan [options] [message]

--mode <text|json>  Run one headless session; JSON emits machine-readable JSONL
--provider <name>   Select a headless model provider
--model <name>      Select a headless model or provider/model reference
--thinking <level>  Select headless thinking: off|minimal|low|medium|high|xhigh|max
-e, --extension <path>  Load an external extension (repeatable; interactive TUI only)
-c, --continue     Continue the most recent session for this directory
-r, --resume       Pick a session to resume
--session <id>     Resume a specific session
--session-dir <dir> Session directory for --session
--diagnostics      Print runtime versions and configuration mode
--host-config <path> Select an absolute trusted host.json path
update             Update a global npm installation of Felan Code
savings            Show persisted estimated API-equivalent savings
daemon <action>     Manage the persistent local daemon
acp                 Serve Agent Client Protocol v1 over stdio
acp login           Configure model-provider credentials in a finite terminal flow
-h, --help         Show help
-v, --version      Print the Felan Code version
--verbose          Show verbose startup details

可能命令打字, 如 felan deamon stop 生成建议并退出 状态 1; 他们从未运行建议的命令, 也从未启动模型会话 . 建议要求一个明确的单一特征编辑器(包括相邻的 转位). 在顶层只检查命令形状的输入:守护进程 动作或命令特定选项,或带有被移植字母的单词. 其他话语和句子仍为发音,包括: saving 财务报告和审定财务报表 updates。 。 。 . 使用 felan -- deamon stop 以提示方式明确发送命令形状的文本. 无效的动作 felan daemon 使用信息总是失败,以及何时 毫不含糊,一个建议.

/restart 重新启动守护进程,然后是 Felan 代码,恢复当前 会话,所以重建守护进程和客户端代码都会生效. /daemon restart 只重新启动守护进程, 并重排当前会话 .

运行 felan update 检查稳定 npm 释放。 它只更新一个经过验证的 全局 npm 安装, 安装时报告, 并告知 ,然后在成功更新后重新启动. npx,本地/来源,以及其他 软件包管理设备不更改;更新有命令的设施 安装它们.

交互启动还同步检查 npm 一次, 以更新稳定 释放。 如果有的话 Felan 代码让你退出所有 Felan 代码会话和 运行 felan update 用于全局 npm 安装,或使用软件包管理器 启动Felan代码。 离线,失败, 和错误的反应保持沉默 Felan代码从不自动安装更新. 设定 FELAN_SKIP_VERSION_CHECK=1 以禁用此启动请求.

无 --mode 附加交互式 TUI 到守护进程 . --mode text 运行一个无头守护进程会话并打印最后的响应; --mode json jSONL会话活动 JSONL Studout是机器可读的,而 诊断和失败将进入非零退出状态。 两种模式 需要及时支持 --continue 财务报告和审定财务报表 --session,并接受 --provider, (中文(简体) ), --model,以及 --thinking 用于可复制的模型选择. --resume 遗 物 仅限互动. 无头启动从不依赖登入或 交互更新检查 。 完成时解开; CI 必须使用明确 单独 --daemon-runtime 并明确阻止那个守护进程.

守护进程生命周期

守护进程在客户端退出后持续存在 。 使用这些管理命令 :

felan daemon status
felan daemon start
felan daemon foreground
felan daemon logs
felan daemon stop
felan daemon restart

status 财务报告和审定财务报表 logs 永远不要开始. start 附加于相容实例或 发射精确安装的守护进程 . foreground 保留在服务处. stop 财务报告和审定财务报表 restart 等待工作结束。 如果它没有完成 在排出期限之前,命令失败,守护进程继续运行; 添加 --force 而不是打断工作。 替换者继承请求的 shell 环境 。 没有 发送或持续发送每次会议的环境。 TUI提议 /daemon status, (中文(简体) ), /daemon logs, (中文(简体) ), /daemon stop,以及 /daemon restart。当正在工作时(运行、子代理、交互式 PTY 或前景进程,以及待决问题) 将中断,他们询问一次 与计数,然后停止或重新启动 马上 从另一个 Felan 版本自动替换守护进程 ; 否则 TUI 将显示当前任务的数量 a 重启会中断并先询问 .

/exit (或Ctrl+D在一空编辑器上)去取. 逃逸中断当前 运行. /close 处理选定的会话。 这些行动不会 意思一样.

如果守护进程连接下降, 例如由于守护进程重新启动, 则 TUI 保持输入可用并显示 Daemon disconnected · reconnecting in Ns · /reconnect to retry now它与后退自动重复(250毫秒, 翻倍到10 s,没有尝试限制),一旦守护进程回来, 重排当前会话并简要显示 Reconnected自动 重试只连接到运行中的守护进程; 它们从不启动, 所以是明确的 felan daemon stop 停下来. /reconnect 立即重试并开始 没有运行时的守护进程 。 断开时提交输入 编辑器; 当连接中断报告时, 请求在飞行中 结果未知, 因为守护进程可能仍在运行 。 非加太客户 在编辑器连接打开时重新连接。 无头文本运行 如果守护进程在 30 秒内未返回, 则失败; JSON 运行在任何运行上失败 中断, 因为他们的事件流无法重放 .

/reload 保留所有背景进程。 守护进程重新启动时会分离 背景进程,恢复会话重新发现,并结束 交互式( PTY) , 如退出 Felan 代码在守护进程前所做的 .

原生非加太语 v1

作为本地代理客户端协议服务器运行 Felan 代码 :

felan acp

或者在没有全局安装的情况下运行已发布的软件包 :

npx --yes @felan-ai/felan acp

felan acp 服务稳定 ACP v1 相对于新线 有限JSON 在stdio。 积分 用于协议框架; 诊断到 stderr 。 非加太客户收到 机器名称 felan 显示标题 Felan Code。每个 ACP 附件是一个守护进程客户端,可以创建、加载、迅速、取消和 从Felan代码会话中分离出来. Felan 代码接受基线文本和资源链接 快速块,重放当前持续在负载上的分支,以及流用户, 帮助、思考和工具呼叫更新。 非加太公司采用严格的守护进程政策: 立即应用到会话树( 运行工具呼叫保留批准) 当最后的ACP客户端调试时, 返回到主机默认值 . EOF不回答待处理的交互或停止会话工作而解析.

当客户端发布终端认证广告时, Felan Code 提供终端 附加方法 login 切换到配置 felan acp 引证. 运行 手动相同的流程 :

felan acp login

当客户端通过 Felan 代码启动时 npx,等同命令为:

npx --yes @felan-ai/felan acp login

有限登录进程支持可配置的 API- key 和 OAuth 提供者 方法,隐藏秘密和手动编码输入,并通过 守护进程拥有的证书商店 $FELAN_AGENT_DIR/auth.json (单位:千美元)~/.felan/auth.json (默认情况下). 不执行或共享文件 。 秘密用麻风布置 回答路径,从不持久交互回答或会话记录。 非加太集团 客户端在终端认证成功后应当重新连接. 形式能力 客户还收到 ask_user 以及非加太国家引领的 " 前行 " 评论.

Zed 自定义代理

安装 felan 在泽德 PATH,然后在 Zed 中添加此自定义代理 settings.json数字 :

{
  "agent_servers": {
    "Felan Code": {
      "type": "custom",
      "command": "felan",
      "args": ["acp"],
      "env": {}
    }
  }
}

对于点播软件包,请使用 "command": "npx" 财务报告和审定财务报表 "args": ["--yes", "@felan-ai/felan", "acp"]。广告终端 附加验证参数,生成单独的 npx --yes @felan-ai/felan acp login 流动.

Zed和Felan代码不自动共享供应商证书. 如果费兰代码需要 认证, 选择其终端登录方法或运行 felan acp login,则 启动新的外部代理连接.

非加太行动安全由守护进程拥有。 已知的突变、过程、网络和未知 工具请求 allow once 或者说 reject once;已知的只读/内部工具可以 继续 批准是持久的守护进程状态,不是沙盒. MCP定义 非加太国家提供 session/new 或者说 session/load 已接受客户端 相容并被忽略. 配置 Felan 代码中单独的 OAuth 远程 HTTP MCP网关通过 mcp.json 换句话说.

目前的非目标包括远距离非加太运输、额外的工作空间根基、, 图像/音频/嵌入式资源提示块、会话模式和配置选项, 和所有会话提供的 MCP 服务器。 非加太公司不推出客户端提供的MCP 处理或披露客户提供的MCP工具、资源、提示、取样、, Apps,或作脚本.

felan --resume 打开只选择一个会话选择器。 按下标签切换 当前文件夹和所有本地会话之间, Ctrl+S 要更改排序, Ctrl+N 要过滤到命名会话, Ctrl+P 要切换会话路径 。 逃脱 在不创建会话的情况下取消. felan --continue 仍为快道 用于当前目录中最近的会话.

新的交互式根会话收到一个同步而简洁的名称 从第一个提示。 名称在会话文件中一直存在,并且有 名字永远不会被替换。 以 builtinExtensions.sessionTitle。 。 。 .

felan --diagnostics 报告Felan代码、代理Core、Pi和Node.js版本加 运行时间和证书模式.

地方国家和政策

默认代理目录是 ~/.felan; 设置 FELAN_AGENT_DIR 来改变它. 它包含本地证书,设置,会话,代理,扩展存储, 和项目内存。 根片段的存储范围为 $FELAN_AGENT_DIR/storage/sessions/<encoded-root-session-id> 和长寿 扩展状态 $FELAN_AGENT_DIR/storage/agent。 。 。 .

本地主机装入源控 Felan 代码内置, Felan 拥有 设置和提示附件,明确的 Felan 代码代理和代理技能 代理 Core 选择的 cwd 指令文件, 并明确外部扩展 当地客户提供可重复添加剂 --extension编号 :-e 旗帜. 远程创建无法提供明确的路径 。 主持人 piExtensions.user 财务报告和审定财务报表 piExtensions.project 设置, 默认关闭, 加载 ~/.pi/agent/extensions 并值得信赖 <cwd>/.pi/extensions 每个新根 : TUI,ACP,无头/打印模式,网络创建和导入会话. 环境派 软件包、提示、主题、项目设置和软件包资源依然存在 已过滤 .

设定 piExtensions.llamaCpp: true 在 Felan 的全局设置中选择加入 Pi 捆绑的 lama.cpp 整合任何客户端的根会话,而不是儿童. 它独立于外部 pi-llama 软件包,不安装或启动 一个路由器,并且不能启用其他 Pi 内置。 重新启动后, 连接到已有的 拉玛.cpp 路由器 /login llama.cpp,使用 /llama,以及 选择一个 /model。 。 。 .

外部扩展路径在创建时固定. 恢复和复制/保留叉 保存路径; 在附加负载上采用无索引的记录 扩展。 儿童,包括子剂和工人,装载其根 外部扩展路径; 工人工具允许列表仍然限制活动工具.

只有创建的 TUI 提示用于项目文件夹信任 。 非加太、无头和网络 创建跳过未决定的文件夹而不保存决定并加载文件夹 已经直接或通过父程序信任 。 外部扩展执行方式 在所有这些会话中当前用户的权限; 它们没有安装 来自网络/包装来源.

当在赫德发射时,TUI报告其Felan代码生命周期和会话 通过Herdr继承的本地套接字环境来识别身份. 硂琌TUI 并且无法进行环境扩展或非加太。 用户注意等待 Pi 延长,包括 ask_user预行道批准/审查,以及当地MCP OAuth, (b) 授权的子剂完成工作仍然是 根工作流程.

所有内置默认启用, 包括 TUI 中的 Powerline 页脚 届会。 二进制后置特性可以保持不活动,直到其依赖状态 已安装或特性通过 /dependencies。 。 。 .

会话压缩也默认启用, 并使用已验证摘要 方法。 设定 extensionConfig.sessionCompaction.method 改为 classifier 要丢弃 当Pi的目录显示时 可用的经认证的分类器模型; 无一个, 或当 分类器失败, 它使用已校验的摘要 。 当闲着的大背景, 在已知的即时缓存寿命之前不久, 扩展缩进也会缩小 期满compactBeforeCacheExpiry) (中文(简体) ). 摘要模式默认使用活动模式或 配置 inherit, (中文(简体) ), xhigh, (中文(简体) ), high, (中文(简体) ), medium,或 low 政策。 分级选择 更喜欢活跃的提供者/家庭,在无法继承时回归继承. 两种方法都保持结构上的连续性并暴露 session_recall 联 合 国 当前活动行系 。 扩展可安全禁用 builtinExtensions.sessionCompaction: false皮的原生收缩器 管制和管制 session_recall 删除.

压缩后,记录片显示完成的方法为: Context compacted · Classifier, (中文(简体) ), Context compacted · Summary,或 Context compacted · Native。扩展符号计数和检查点的行。 如果费兰不能 完成它的方法, 警告是简洁的, 本地的 Pi 紧接.

Core按需要批发完整的分类器问题集 主机通过运行时间曝光代理Core分类器. 受约束的收缩 将证据发送给选定的分类提供者的终点。 调试日志 默认为 storage('agent')/logs/felan.jsonl。 。 。 . 设定 FELAN_LOG_LEVEL=off 以禁用它们,或 debug编号 :info编号 :warn编号 :error 改为 更改级别.

选择 分类模型 内 /settings 或设置 felanClassifier.model 改为 auto (默认)或确切的参考,例如 openrouter/typesafe/jev-1.13。自动更喜欢直接的Safe Jev,然后是现有的 OpenRouter Jev, 然后是其他Jev路线, 然后是第一个剩下的认证 按目录顺序分类。 无法明确选择的警告和用途 自动不覆盖设置; 没有可用的分类器保留正常 堕倒. 更改适用于下一个新的根会话/重新开始 。 皮拥有 认证存储/目录/运输;代理Core保留一个 classify 操作和操作 共享2秒根飞行前。 报告使用原产地代币,但缺失 目录定价没有被验证为自由推断.

可用认证分类器时, 本地主机 还可以提供分类指导。 对于子剂, 根会得到发现 请求需要广泛发现时的路由部分,但一发除外 无法等待儿童完成通知或小寄存器的打印/JSON模式. Agent 没有被绑定的模型的呼叫会获得分类器选择的分级. 对于Prewalk,分类器 建议进入,设置规划勘探深度,可能提高执行 分级或思考级别,并检查代理运行边界的完成情况. 没有分类器,或者在呼叫失败时,模式遵循持续授权 和预行指南,并应用已配置的默认值.

代码库内存是默认内置. 它提供结构代码 搜索,符号读取,并绑定grep扩增,辅以 codebase-memory-mcp 二进制.

二进制是单独的下载,不自动安装. 运行 /codebase-memory install 获取已审查的二进制. 一旦获得, Felan 代码将在会话中索引活动存储器 开始并重新使用整个会话的索引.

运行 /codebase-memory refresh 以重建显著后的索引 编辑.

当地TUI提供 felan-light 财务报告和审定财务报表 felan-dark 作为主机拥有的 Pi 主题. JSON 文件输入 $FELAN_AGENT_DIR/themes (默认) ~/.felan/themes)作为用户加载 主题和阴影这些ID 当 JSON name 匹配,所以自定义为暗 调色板存活 felan update。启动视图使用紧凑的 Felan 代码 欢迎; 新闻 Ctrl+O 当您需要完整的启动帮助和加载资源时 列出。 当没有保存主题时, Felan 代码遵循终端背景 (OSC 11) 自动而不是OS色相(CSI 997). 这个 felan-* 名称是故意的: Pi 保留地 dark 财务报告和审定财务报表 light 用于内部 导出主题, 这样相撞的ID会让导出会话使用不同的 颜色 Powerline 消耗相同的活动主题而不是定义它自己的主题 颜色. 新安装默认使用Pi的全屏TUI模式. 一个保存 tuiMode 设置 继续优先; 使用 /settings 切换到 fullscreen 财务报告和审定财务报表 regular。提示使用 Pi 的本地编辑器渲染,其一列为 默认水平补丁;已保存 editorPaddingX 价值观优先.

使用内置的模型响应 concise 默认输出样式。 设定 全球 outputStyle 设置为 explanatory 更多的推理和背景. 简洁的风格更喜欢最小的道具、清晰的碎片和紧凑的子弹 保留准确的技术内容、条件、警告、核查, 和阻塞器;当压缩可以造成模糊性或安全性时会扩展 风险。 使用 extensionConfig.outputStyle.style: custom 明确 instructions 或者说 instructionsFile 测试替代的即时措辞; 页:1 配置指南 文档验证、路径解析和会话周期行为.

Canonic 用户文档

包 README 故意保持短. 使用这些指南进行操作 细节 :

发展

资料来源: apps/felan 内 https://github.com/felan-ai/felan 页面存档备份,存于互联网档案馆。 。 。 .

corepack enable
pnpm install --frozen-lockfile
pnpm --filter @felan-ai/felan build
pnpm --filter @felan-ai/felan type-check
scripts/test-isolated.sh pnpm --filter @felan-ai/felan test

仅开发的根预览( E)pnpm theme:preview)显示两者 主机拥有的主题跨越了代表Pi,编辑和Powerline状态. 这个 故意是浏览器相近而非第二个渲染器.

运行 scripts/test-isolated.sh pnpm verify 从寄存器根中取出用于交叉包装和组合二进制 覆盖.

版本与发布记录

@felan-ai/felan 共发布 188 个版本,首次发布于 2026/08/03;过去 12 个月发布了 188 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.39.6latest2026/11/13今天
0.39.52026/11/131 天前
0.39.42026/11/131 天前
0.39.32026/11/122 天前
0.39.22026/11/104 天前
0.39.12026/11/104 天前

其他发布通道:bootstrap → 0.0.0-bootstrap.0,next → 0.21.16-cbm.0。

关于 @felan-ai/felan 的常见问题

@felan-ai/felan 是什么?

Felan Code:一种为成本效益高,可核查的软件工作而建造的开源可移植模型编码剂

如何安装 @felan-ai/felan?

在项目目录运行 npm install @felan-ai/felan,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 felan,可以用 npx felan 直接运行。

@felan-ai/felan 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@felan-ai/felan 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@felan-ai/felan 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.19.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@felan-ai/felan 可以商用吗?

@felan-ai/felan 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@felan-ai/felan 的下载量有多少?

根据 npm 官方下载统计,@felan-ai/felan 在 2026/10/15 – 2026/11/13 这 30 天内被下载 7,080 次,日均约 236 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@felan-ai/felan 还在维护吗?

最新版本 0.39.6 发布于 2026/11/13(今天);至今共发布 188 个版本,其中过去 12 个月发布了 188 个;首次发布于 2026/08/03。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。