跳转至正文

API参考

JARFIS斜杠命令、.jarfis-state.json架构、学习文件结构和Phase规范的完整参考。

最后更新: Sun Mar 15 2026 00:00:00 GMT+0000 (Coordinated Universal Time)

API参考

所有JARFIS命令、状态架构和配置文件的完整参考。

斜杠命令

/jarfis:work

启动JARFIS工作流的主要命令。从Triage到Retrospective执行完整的Phase流水线。

Syntax
/jarfis:work [description]
/jarfis:work [description] --meeting [meeting-name]
Parameters
descriptionrequired要实现的功能或任务的自然语言描述
--meetingoptional用作输入上下文的之前/jarfis:meeting会话名称
Examples
/jarfis:work Build a user authentication system with JWT tokens
/jarfis:work Add Stripe subscription billing --meeting billing-kickoff
/jarfis:work Fix the broken cart calculation on checkout page

/jarfis:meeting

启动用于规划和对齐的结构化启动会议。会议结果会被存储,可以在后续/jarfis:work会话中引用。

Syntax
/jarfis:meeting [topic]
Parameters
topicrequired会议的主题或议程
Examples
/jarfis:meeting Define the authentication strategy for the mobile app
/jarfis:meeting Decide on database schema for multi-tenant architecture

/jarfis:continue

继续已完成工作流的后续任务。重用上一个工作流的分支和artifact,高效执行后续工作。

Syntax
/jarfis:continue [description]
/jarfis:continue [description] --workflow [path]
/jarfis:continue [description] --mode fix|extend
Parameters
descriptionrequired后续任务的自然语言描述
--workflowoptional直接指定工作流目录路径
--modeoptional明确指定模式:fix(修复bug)或extend(功能扩展)
Examples
/jarfis:continue Add unit tests for the authentication module
/jarfis:continue Fix the token refresh edge case --mode fix
/jarfis:continue Add OAuth support --workflow .jarfis/works/2026-03-10/auth-system

/jarfis:implement

修改或添加JARFIS系统本身的专用命令。用于修改命令、agent和内部结构。

Syntax
/jarfis:implement [description]
Parameters
descriptionrequiredJARFIS系统修改或添加的描述
Examples
/jarfis:implement Add a new /jarfis:standup command for daily status reports
/jarfis:implement Modify the QA agent to include performance testing

/jarfis:project-init

通过分析当前代码库生成项目概要。创建包含项目结构、依赖关系和convention信息的.jarfis/project-profile.md。

Syntax
/jarfis:project-init
Examples
/jarfis:project-init

/jarfis:project-update

更新现有项目概要以反映自上次初始化以来代码库的变化。

Syntax
/jarfis:project-update
Examples
/jarfis:project-update

/jarfis:health

诊断JARFIS环境中的僵尸进程和其他运营问题。

Syntax
/jarfis:health
Examples
/jarfis:health

/jarfis:upgrade

管理学习条目 — 审查、编辑和整理学习系统中的条目。

Syntax
/jarfis:upgrade
Examples
/jarfis:upgrade

/jarfis:version

显示和管理JARFIS版本信息。

Syntax
/jarfis:version
Examples
/jarfis:version

/jarfis:distill

执行提示词蒸馏 — 优化和压缩提示词内容以提高效率。

Syntax
/jarfis:distill
Examples
/jarfis:distill

状态文件:.jarfis-state.json

状态文件跟踪当前工作流进度。位于项目根目录。

架构

{
  "work_name": "string",
  "docs_dir": "string(artifact目录路径)",
  "branch": "string(Git分支名称)",
  "base_branch": "string(合并目标基础分支)",
  "current_phase": "number | \"done\"",
  "required_roles": {
    "backend": "boolean",
    "frontend": "boolean",
    "ux": "boolean",
    "devops": "boolean",
    "security": "boolean"
  },
  "api_spec_required": "boolean",
  "phases": {
    "T": { "status": "pending | in_progress | completed | skipped" },
    "0": { "status": "..." },
    "6": { "status": "..." }
  },
  "last_checkpoint": {
    "timestamp": "ISO 8601字符串",
    "phase": "number",
    "summary": "string"
  },
  "meeting_ref": "string(可选,会议名称)",
  "meeting_dir": "string(可选,会议artifact路径)"
}

字段参考

.jarfis-state.json 字段参考
FieldTypeDescription
work_namestring当前工作流的标识符
docs_dirstringartifact存储路径
branchstring为此工作流创建的Git分支
base_branchstring合并回的目标分支
current_phasenumber | "done"活跃Phase编号
required_rolesobject指示哪些Agent角色处于活跃状态的布尔标志
api_spec_requiredboolean是否需要API规范文档
workspaceobject项目结构元数据
phasesobject各Phase状态(pending / in_progress / completed / skipped)
last_checkpointobject最后保存进度的时间戳和摘要
meeting_refstring?关联会议的引用(使用--meeting时)
meeting_dirstring?关联会议artifact的路径

学习文件

全局学习:~/.claude/jarfis-learnings.md

位于用户主目录,所有项目共享。包含两个主要部分:

  • Agent Hints — 从Retrospective积累的行为规则和指南
  • Workflow Patterns — 常见场景的经过验证的模式

此文件在每个工作流的Phase 0(Pre-flight)期间加载。

项目上下文:.jarfis/context.md

注入Agent提示词的项目特定上下文。包含技术栈详情、convention、领域知识和集成约束。

项目概要:.jarfis/project-profile.md

/jarfis:project-init自动生成。描述项目的结构、依赖关系、构建工具和配置。通过/jarfis:project-update更新。


Phase参考

  1. Triage

    请求分类(A/B/C类型确定)

  2. Pre-flight

    Git同步、分支创建、学习文件加载

  3. Discovery

    PO逆向提问、Working Backwards、PRD、可行性评估

  4. Architecture & Planning

    影响分析、系统设计、API规范(条件触发)、任务分解、测试策略

  5. UX Design

    界面设计、交互设计、SVG资产、设计令牌(条件触发:仅在需要UI时)

  6. Implementation

    BE/FE/DevOps并行实现(仅有任务的部分)

  7. Operational Readiness

    部署策略、回滚计划、运维就绪检查

  8. Review & QA

    API契约验证、Tech Lead + QA + Security并行审查

  9. Retrospective

    学习积累(全局learnings + 项目context)

Gate参考

GATE 1

Phase 1之后

批准

进入Phase 2

修改

请求更改并重新呈现

中止

取消工作流

GATE 2

Phase 2 & 3之后

批准

进入Phase 4

修改

请求更改并重新呈现

中止

取消工作流

GATE 3

Phase 5之后

批准

进入Phase 6

修改后重审

请求修复并触发另一个审查周期

中止

取消工作流

重新审视设计

返回Phase 2进行根本性重新设计


另请参阅