Getting Started

# Install GitFables
npm install -g gitfables-cli

# Generate a story
gitfables story create --repo ./my-project

{
  "repository": {
    "url": "https://github.com/user/repo",
    "branch": "main"
  },
  "templates": {
    "default": "technical-journey",
    "customPath": "./templates"
  },
  "output": {
    "format": "markdown",
    "directory": "./stories"
  }
}

---
name: Technical Journey
description: A technical narrative of your project
variables:
  timeframe:
    start: "2024-01-01"
    end: "2024-02-01"
  focus:
    - architecture
    - performance
    - security
---

# Project Journey: {{ repository.name }}

## Overview
{{ repository.description }}

## Key Milestones
{{ milestones | format_list }}