Skip to main content

API Reference

Complete reference for JARFIS slash commands, .jarfis-state.json schema, learning file structure, and phase specifications.

Last updated: Sun Mar 15 2026 00:00:00 GMT+0000 (Coordinated Universal Time)

API Reference

Complete reference for all JARFIS commands, state schema, and configuration files.

Slash Commands

/jarfis:work

The primary command to start a JARFIS workflow. Initiates the full phase pipeline from Triage through Retrospective.

Syntax
/jarfis:work [description]
/jarfis:work [description] --meeting [meeting-name]
Parameters
descriptionrequiredNatural language description of the feature or task to implement
--meetingoptionalName of a previous /jarfis:meeting session to use as input context
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

Initiates a structured kickoff meeting for planning and alignment. Meeting results are stored and can be referenced by subsequent /jarfis:work sessions.

Syntax
/jarfis:meeting [topic]
Parameters
topicrequiredThe subject or agenda for the meeting
Examples
/jarfis:meeting Define the authentication strategy for the mobile app
/jarfis:meeting Decide on database schema for multi-tenant architecture

/jarfis:continue

Continues a completed workflow with a follow-up task. Reuses the existing branch and artifacts from the previous workflow for efficient follow-up work.

Syntax
/jarfis:continue [description]
/jarfis:continue [description] --workflow [path]
/jarfis:continue [description] --mode fix|extend
Parameters
descriptionrequiredNatural language description of the follow-up task
--workflowoptionalDirectly specify the workflow directory path
--modeoptionalExplicitly specify mode: fix (bug fix) or extend (feature extension)
Examples
/jarfis:continue Add unit tests for the authentication module
/jarfis:continue Fix the edge case in cart validation --mode fix
/jarfis:continue Add OAuth support --workflow .jarfis/works/2026-03-10/auth-system

/jarfis:implement

Modifies or adds to the JARFIS system itself — commands, agents, and internal structure. The dedicated command for JARFIS self-improvement.

Syntax
/jarfis:implement [description]
Parameters
descriptionrequiredDescription of the JARFIS system modification or addition
Examples
/jarfis:implement Add a new /jarfis:standup command for daily status reports
/jarfis:implement Modify the QA agent to include performance testing
/jarfis:implement Update the Retrospective phase to output a structured JSON summary

/jarfis:project-init

Generates a project profile by analyzing the current codebase. Creates .jarfis/project-profile.md with information about the project structure, dependencies, and conventions.

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

/jarfis:project-update

Updates an existing project profile to reflect changes in the codebase since the last initialization.

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

/jarfis:health

Diagnoses zombie processes and other operational issues in the JARFIS environment.

Syntax
/jarfis:health
Examples
/jarfis:health

/jarfis:upgrade

Manages learning items — review, edit, and curate entries in the learning system.

Syntax
/jarfis:upgrade
Examples
/jarfis:upgrade

/jarfis:version

Displays and manages JARFIS version information.

Syntax
/jarfis:version
Examples
/jarfis:version

/jarfis:distill

Performs prompt distillation — optimizes and compresses prompt content for efficiency.

Syntax
/jarfis:distill
Examples
/jarfis:distill

State File: .jarfis-state.json

The state file tracks the current workflow progress. Located at the project root.

Schema

{
  "work_name": "string",
  "docs_dir": "string (path to artifact directory)",
  "branch": "string (Git branch name)",
  "base_branch": "string (base branch for merge)",
  "current_phase": "number | \"done\"",
  "required_roles": {
    "backend": "boolean",
    "frontend": "boolean",
    "ux": "boolean",
    "devops": "boolean",
    "security": "boolean"
  },
  "api_spec_required": "boolean",
  "workspace": {
    "type": "\"monorepo\" | \"multi-project\"",
    "projects": ["string (project paths)"]
  },
  "phases": {
    "T": { "status": "pending | in_progress | completed | skipped" },
    "0": { "status": "..." },
    "1": { "status": "..." },
    "2": { "status": "..." },
    "3": { "status": "..." },
    "4": { "status": "..." },
    "4.5": { "status": "..." },
    "5": { "status": "..." },
    "6": { "status": "..." }
  },
  "last_checkpoint": {
    "timestamp": "ISO 8601 string",
    "phase": "number",
    "summary": "string"
  },
  "meeting_ref": "string (optional, meeting name)",
  "meeting_dir": "string (optional, path to meeting artifacts)"
}

Field Reference

.jarfis-state.json field reference
FieldTypeDescription
work_namestringIdentifier for the current workflow
docs_dirstringPath where artifacts are stored
branchstringGit branch created for this workflow
base_branchstringBranch to merge back into
current_phasenumber | "done"Active phase number
required_rolesobjectBoolean flags for which agent roles are active
api_spec_requiredbooleanWhether API specification document is needed
workspaceobjectProject structure metadata
phasesobjectPer-phase status (pending / in_progress / completed / skipped)
last_checkpointobjectTimestamp and summary of last saved progress
meeting_refstring?Reference to a linked meeting (when --meeting was used)
meeting_dirstring?Path to the linked meeting's artifacts

Learning Files

Global Learnings: ~/.claude/jarfis-learnings.md

Located in the user's home directory. Shared across all projects. Contains two main sections:

  • Agent Hints — Behavioral rules and guidelines accumulated from retrospectives
  • Workflow Patterns — Proven patterns for common scenarios

This file is loaded during Phase 0 (Pre-flight) of every workflow.

Project Context: .jarfis/context.md

Project-specific context injected into agent prompts. Contains tech stack details, conventions, domain knowledge, and integration constraints.

Project Profile: .jarfis/project-profile.md

Auto-generated by /jarfis:project-init. Describes the project's structure, dependencies, build tools, and configuration. Updated via /jarfis:project-update.

Phase Reference

  1. Triage

    Request classification (A/B/C type determination)

  2. Pre-flight

    Git synchronization, branch creation, learning file loading

  3. Discovery

    PO reverse-questions, Working Backwards, PRD, feasibility assessment

  4. Architecture & Planning

    Impact analysis, system design, API spec (conditional), task breakdown, test strategy

  5. UX Design

    Screen design, interaction design, SVG assets, design tokens (conditional: only when UI is needed)

  6. Implementation

    BE/FE/DevOps parallel implementation (only parts with tasks)

  7. Operational Readiness

    Deployment strategy, rollback plan, operational readiness check

  8. Review & QA

    API contract verification, Tech Lead + QA + Security parallel reviews

  9. Retrospective

    Learning accumulation (global learnings + project context)

Gate Reference

GATE 1

After Phase 1

Approve

Proceed to Phase 2

Revise

Request changes and re-present

Abort

Cancel workflow

GATE 2

After Phases 2 & 3

Approve

Proceed to Phase 4

Revise

Request changes and re-present

Abort

Cancel workflow

GATE 3

After Phase 5

Approve

Proceed to Phase 6

Revise & re-review

Request fixes and trigger another review cycle

Abort

Cancel workflow

Revisit design

Return to Phase 2 for fundamental redesign

See Also