@shepai/cli 1.44.1 → 1.45.0

package/apis/json-schema/Plan.yaml

@@ -0,0 +1,37 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: Plan.yaml
+type: object
+properties:
+  overview:
+    type: string
+    description: High-level overview describing the implementation approach
+  requirements:
+    type: array
+    items:
+      $ref: Requirement.yaml
+    description: User and inferred requirements that this plan addresses
+  artifacts:
+    type: array
+    items:
+      $ref: Artifact.yaml
+    description: Documents and artifacts to be produced as part of this plan
+  tasks:
+    type: array
+    items:
+      $ref: Task.yaml
+    description: Work items (tasks) that comprise this implementation plan
+  state:
+    $ref: PlanState.yaml
+    description: Current state of the plan execution lifecycle
+  workPlan:
+    $ref: GanttViewData.yaml
+    description: Optional Gantt chart visualization data for work scheduling
+required:
+  - overview
+  - requirements
+  - artifacts
+  - tasks
+  - state
+allOf:
+  - $ref: BaseEntity.yaml
+description: Implementation plan for a feature containing tasks, artifacts, and requirements

package/apis/json-schema/PlanPhase.yaml

@@ -0,0 +1,26 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PlanPhase.yaml
+type: object
+properties:
+  id:
+    type: string
+    description: Unique identifier for this phase (e.g., 'phase-1')
+  name:
+    type: string
+    description: Display name of the phase
+  description:
+    type: string
+    description: Description of what this phase accomplishes and why it's ordered this way
+  parallel:
+    type: boolean
+    description: Whether tasks in this phase can be executed in parallel
+  taskIds:
+    type: array
+    items:
+      type: string
+    description: Task IDs belonging to this phase (e.g., ['task-1', 'task-2']). Optional — not present in plan.yaml phases.
+required:
+  - id
+  - name
+  - parallel
+description: Implementation phase grouping related tasks

package/apis/json-schema/PlanSpec.yaml

@@ -0,0 +1,26 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PlanSpec.yaml
+type: object
+properties:
+  phases:
+    type: array
+    items:
+      $ref: PlanPhase.yaml
+    description: Structured implementation phases with task groupings
+  filesToCreate:
+    type: array
+    items:
+      type: string
+    description: New files planned to be created
+  filesToModify:
+    type: array
+    items:
+      type: string
+    description: Existing files planned to be modified
+required:
+  - phases
+  - filesToCreate
+  - filesToModify
+allOf:
+  - $ref: SpecArtifactBase.yaml
+description: Implementation plan artifact defining strategy and file changes

package/apis/json-schema/PlanState.yaml

@@ -0,0 +1,8 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PlanState.yaml
+type: string
+enum:
+  - Requirements
+  - ClarificationRequired
+  - Ready
+description: States for plan entities during the planning phase

package/apis/json-schema/PortMap.yaml

@@ -0,0 +1,19 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PortMap.yaml
+type: object
+properties:
+  name:
+    type: string
+    description: Service name identifier (e.g., 'web', 'api', 'db', 'redis')
+  port:
+    type: integer
+    minimum: -2147483648
+    maximum: 2147483647
+    description: Port number to expose on the host or container network
+  protocol:
+    $ref: PortProtocol.yaml
+    description: Network protocol for the port (defaults to TCP if not specified)
+required:
+  - name
+  - port
+description: Port mapping configuration for exposing container services to the network

package/apis/json-schema/PortProtocol.yaml

@@ -0,0 +1,7 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PortProtocol.yaml
+type: string
+enum:
+  - TCP
+  - UDP
+description: Network transport protocols for port configuration

package/apis/json-schema/PrStatus.yaml

@@ -0,0 +1,8 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PrStatus.yaml
+type: string
+enum:
+  - Open
+  - Merged
+  - Closed
+description: Pull request status for a feature

package/apis/json-schema/PrdApprovalPayload.yaml

@@ -0,0 +1,15 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PrdApprovalPayload.yaml
+type: object
+properties:
+  approved:
+    type: boolean
+    description: Always true for approval payloads
+  changedSelections:
+    type: array
+    items:
+      $ref: QuestionSelectionChange.yaml
+    description: List of selection changes the user made during review (empty if no changes)
+required:
+  - approved
+description: Payload sent when user approves a PRD with optional selection changes

package/apis/json-schema/PrdFinalAction.yaml

@@ -0,0 +1,18 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PrdFinalAction.yaml
+type: object
+properties:
+  id:
+    type: string
+    description: Unique identifier for this action
+  label:
+    type: string
+    description: Button label text
+  description:
+    type: string
+    description: Description of what this action does
+required:
+  - id
+  - label
+  - description
+description: Configuration for the final action button in the questionnaire

package/apis/json-schema/PrdOption.yaml

@@ -0,0 +1,24 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PrdOption.yaml
+type: object
+properties:
+  id:
+    type: string
+    description: Unique identifier for this option
+  label:
+    type: string
+    description: Display label for this option
+  rationale:
+    type: string
+    description: Explanation of why this option is relevant
+  recommended:
+    type: boolean
+    description: Whether this option is recommended by AI analysis
+  isNew:
+    type: boolean
+    description: Whether this option was newly added after refinement
+required:
+  - id
+  - label
+  - rationale
+description: A selectable option within a PRD questionnaire question

package/apis/json-schema/PrdQuestion.yaml

@@ -0,0 +1,25 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PrdQuestion.yaml
+type: object
+properties:
+  id:
+    type: string
+    description: Unique identifier for this question
+  question:
+    type: string
+    description: The question text displayed to the user
+  type:
+    type: string
+    const: select
+    description: Question interaction type (currently only single-select)
+  options:
+    type: array
+    items:
+      $ref: PrdOption.yaml
+    description: Available options for this question
+required:
+  - id
+  - question
+  - type
+  - options
+description: A single question in the PRD questionnaire with selectable options

package/apis/json-schema/PrdQuestionnaireData.yaml

@@ -0,0 +1,24 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PrdQuestionnaireData.yaml
+type: object
+properties:
+  question:
+    type: string
+    description: Header title text for the questionnaire
+  context:
+    type: string
+    description: Header context/description text
+  questions:
+    type: array
+    items:
+      $ref: PrdQuestion.yaml
+    description: Array of questions to display
+  finalAction:
+    $ref: PrdFinalAction.yaml
+    description: Configuration for the finalize/approve action button
+required:
+  - question
+  - context
+  - questions
+  - finalAction
+description: Complete data for rendering a PRD questionnaire

package/apis/json-schema/PrdRejectionPayload.yaml

@@ -0,0 +1,20 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PrdRejectionPayload.yaml
+type: object
+properties:
+  rejected:
+    type: boolean
+    description: Always true for rejection payloads
+  feedback:
+    type: string
+    description: User's feedback explaining what needs to change
+  iteration:
+    type: integer
+    minimum: -2147483648
+    maximum: 2147483647
+    description: Iteration number (1-based, derived from PhaseTiming row count)
+required:
+  - rejected
+  - feedback
+  - iteration
+description: Payload sent when user rejects a PRD with feedback for iteration

package/apis/json-schema/PrdReviewResult.yaml

@@ -0,0 +1,19 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PrdReviewResult.yaml
+type: object
+properties:
+  questions:
+    type: array
+    items:
+      $ref: ReviewQuestion.yaml
+    description: All questions with their final selection state
+  action:
+    type: string
+    description: "User action: approve or reject"
+  feedback:
+    type: string
+    description: Rejection feedback (only present when action is 'reject')
+required:
+  - questions
+  - action
+description: Result of the PRD review TUI interaction

package/apis/json-schema/PullRequest.yaml

@@ -0,0 +1,26 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: PullRequest.yaml
+type: object
+properties:
+  url:
+    type: string
+    description: GitHub PR URL
+  number:
+    type: integer
+    minimum: -2147483648
+    maximum: 2147483647
+    description: GitHub PR number
+  status:
+    $ref: PrStatus.yaml
+    description: Current PR status
+  commitHash:
+    type: string
+    description: Final commit SHA after push
+  ciStatus:
+    $ref: CiStatus.yaml
+    description: CI pipeline status
+required:
+  - url
+  - number
+  - status
+description: Pull request tracking data for a feature

package/apis/json-schema/QuestionOption.yaml

@@ -0,0 +1,18 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: QuestionOption.yaml
+type: object
+properties:
+  option:
+    type: string
+    description: The option text describing the potential approach or answer
+  description:
+    type: string
+    description: Description explaining this option's benefits and approach
+  selected:
+    type: boolean
+    description: Whether this option was the one ultimately selected
+required:
+  - option
+  - description
+  - selected
+description: Option for resolving an open question

package/apis/json-schema/QuestionSelectionChange.yaml

@@ -0,0 +1,14 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: QuestionSelectionChange.yaml
+type: object
+properties:
+  questionId:
+    type: string
+    description: ID of the open question being changed (the question text)
+  selectedOption:
+    type: string
+    description: The option text that the user selected
+required:
+  - questionId
+  - selectedOption
+description: Change to a question's selected option during PRD review

package/apis/json-schema/RejectionFeedbackEntry.yaml

@@ -0,0 +1,21 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: RejectionFeedbackEntry.yaml
+type: object
+properties:
+  iteration:
+    type: integer
+    minimum: -2147483648
+    maximum: 2147483647
+    description: Iteration number (1-based)
+  message:
+    type: string
+    description: User's feedback message explaining what needs to change
+  timestamp:
+    type: string
+    format: date-time
+    description: When the rejection occurred
+required:
+  - iteration
+  - message
+  - timestamp
+description: Rejection feedback entry for PRD iteration tracking

package/apis/json-schema/Requirement.yaml

@@ -0,0 +1,26 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: Requirement.yaml
+type: object
+properties:
+  slug:
+    type: string
+    description: URL-friendly short identifier for the requirement
+  userQuery:
+    type: string
+    description: The original user query that generated this requirement
+  type:
+    $ref: RequirementType.yaml
+    description: Classification type of the requirement (Functional or NonFunctional)
+  researches:
+    type: array
+    items:
+      $ref: Research.yaml
+    description: Research activities conducted to clarify or validate this requirement
+required:
+  - slug
+  - userQuery
+  - type
+  - researches
+allOf:
+  - $ref: BaseEntity.yaml
+description: A user or inferred requirement attached to a feature

package/apis/json-schema/RequirementType.yaml

@@ -0,0 +1,7 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: RequirementType.yaml
+type: string
+enum:
+  - Functional
+  - NonFunctional
+description: Types of requirements based on their nature

package/apis/json-schema/Research.yaml

@@ -0,0 +1,26 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: Research.yaml
+type: object
+properties:
+  topic:
+    type: string
+    description: The topic or subject being researched
+  state:
+    $ref: ResearchState.yaml
+    description: Current state of the research activity (NotStarted, Running, Finished)
+  summary:
+    type: string
+    description: Summary of research findings and recommendations
+  artifacts:
+    type: array
+    items:
+      $ref: Artifact.yaml
+    description: Artifacts produced during the research activity
+required:
+  - topic
+  - state
+  - summary
+  - artifacts
+allOf:
+  - $ref: BaseEntity.yaml
+description: A research topic exploration for gathering technical information

package/apis/json-schema/ResearchArtifact.yaml

@@ -0,0 +1,14 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: ResearchArtifact.yaml
+type: object
+properties:
+  decisions:
+    type: array
+    items:
+      $ref: TechDecision.yaml
+    description: Structured technology decisions with rationale
+required:
+  - decisions
+allOf:
+  - $ref: SpecArtifactBase.yaml
+description: Research artifact documenting technical analysis and decisions

package/apis/json-schema/ResearchSpec.yaml

@@ -0,0 +1,14 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: ResearchSpec.yaml
+type: object
+properties:
+  decisions:
+    type: array
+    items:
+      $ref: TechDecision.yaml
+    description: Structured technology decisions with rationale
+required:
+  - decisions
+allOf:
+  - $ref: SpecArtifactBase.yaml
+description: Research artifact documenting technical analysis and decisions

package/apis/json-schema/ResearchState.yaml

@@ -0,0 +1,8 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: ResearchState.yaml
+type: string
+enum:
+  - NotStarted
+  - Running
+  - Finished
+description: States for research activities during analysis

package/apis/json-schema/ReviewQuestion.yaml

@@ -0,0 +1,24 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: ReviewQuestion.yaml
+type: object
+properties:
+  question:
+    type: string
+    description: The question text
+  options:
+    type: array
+    items:
+      $ref: QuestionOption.yaml
+    description: Available options with selection state
+  selectedOption:
+    type: string
+    description: The option text that was selected by the user
+  changed:
+    type: boolean
+    description: Whether the user changed the selection from the AI default
+required:
+  - question
+  - options
+  - selectedOption
+  - changed
+description: A single question with its options as presented in the review TUI

package/apis/json-schema/SdlcLifecycle.yaml

@@ -0,0 +1,13 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: SdlcLifecycle.yaml
+type: string
+enum:
+  - Started
+  - Analyze
+  - Requirements
+  - Research
+  - Planning
+  - Implementation
+  - Review
+  - Maintain
+description: Software Development Lifecycle stages for feature progression

package/apis/json-schema/Settings.yaml

@@ -0,0 +1,36 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: Settings.yaml
+type: object
+properties:
+  models:
+    $ref: ModelConfiguration.yaml
+    description: AI model configuration for different agents
+  user:
+    $ref: UserProfile.yaml
+    description: User profile information
+  environment:
+    $ref: EnvironmentConfig.yaml
+    description: Environment and tooling preferences
+  system:
+    $ref: SystemConfig.yaml
+    description: System-level parameters
+  agent:
+    $ref: AgentConfig.yaml
+    description: AI coding agent selection and authentication
+  notifications:
+    $ref: NotificationPreferences.yaml
+    description: Notification preferences for agent lifecycle events
+  workflow:
+    $ref: WorkflowConfig.yaml
+    description: Global workflow configuration defaults
+required:
+  - models
+  - user
+  - environment
+  - system
+  - agent
+  - notifications
+  - workflow
+allOf:
+  - $ref: BaseEntity.yaml
+description: Global Shep platform settings (singleton)

package/apis/json-schema/SoftDeletableEntity.yaml

@@ -0,0 +1,11 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: SoftDeletableEntity.yaml
+type: object
+properties:
+  deletedAt:
+    type: string
+    format: date-time
+    description: Timestamp when this entity was soft-deleted (null if not deleted)
+allOf:
+  - $ref: BaseEntity.yaml
+description: Entity that supports soft deletion with a deletedAt timestamp

package/apis/json-schema/SpecArtifactBase.yaml

@@ -0,0 +1,44 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: SpecArtifactBase.yaml
+type: object
+properties:
+  name:
+    type: string
+    description: Artifact title / feature name
+  summary:
+    type: string
+    description: Short description of the artifact's purpose
+  content:
+    type: string
+    description: Raw Markdown body containing the human-written spec content
+  technologies:
+    type: array
+    items:
+      type: string
+    description: Key technologies mentioned or evaluated in this artifact
+  relatedFeatures:
+    type: array
+    items:
+      type: string
+    description: References to other spec IDs (e.g., '008-agent-configuration')
+  relatedLinks:
+    type: array
+    items:
+      type: string
+    description: URLs to external documentation, references, or comparisons
+  openQuestions:
+    type: array
+    items:
+      $ref: OpenQuestion.yaml
+    description: Structured open questions for validation gate checks
+required:
+  - name
+  - summary
+  - content
+  - technologies
+  - relatedFeatures
+  - relatedLinks
+  - openQuestions
+allOf:
+  - $ref: BaseEntity.yaml
+description: Base entity for spec artifacts with common metadata fields

package/apis/json-schema/SpecTask.yaml

@@ -0,0 +1,45 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: SpecTask.yaml
+type: object
+properties:
+  id:
+    type: string
+    description: Unique identifier for this task (e.g., 'task-1')
+  phaseId:
+    type: string
+    description: ID of the phase this task belongs to (e.g., 'phase-1')
+  title:
+    type: string
+    description: Task title or name
+  description:
+    type: string
+    description: Detailed description of what this task accomplishes
+  state:
+    $ref: TaskState.yaml
+    description: Current state of the task
+  dependencies:
+    type: array
+    items:
+      type: string
+    description: IDs of other SpecTasks that must complete before this task starts
+  acceptanceCriteria:
+    type: array
+    items:
+      type: string
+    description: List of acceptance criteria that define task completion
+  tdd:
+    $ref: TddCycle.yaml
+    description: TDD cycle definition for this task (if applicable)
+  estimatedEffort:
+    type: string
+    description: Estimated effort (e.g., '2 hours', '1 day')
+required:
+  - id
+  - phaseId
+  - title
+  - description
+  - state
+  - dependencies
+  - acceptanceCriteria
+  - estimatedEffort
+description: Task definition within a spec's task breakdown

package/apis/json-schema/SystemConfig.yaml

@@ -0,0 +1,16 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: SystemConfig.yaml
+type: object
+properties:
+  autoUpdate:
+    type: boolean
+    default: true
+    description: CLI auto-update preference
+  logLevel:
+    type: string
+    default: info
+    description: Log level for CLI output
+required:
+  - autoUpdate
+  - logLevel
+description: System configuration