Getting Started
Get started with GitFables and learn how to generate stories from your Git repositories.
1
Overview
GitFables helps you generate engaging stories from your Git repositories.
Key features:
- Automated story generation from Git history
- Customizable story templates
- Team collaboration tools
- Integration with popular development tools
2
Quick Links
Get started quickly with these guides.
3
Basic Usage
Generate your first story in minutes.
- Install GitFables
- Connect your repository
- Choose a story template
- Generate your first story
terminal
Bash
# Install GitFables
npm install -g gitfables-cli
# Generate a story
gitfables story create --repo ./my-projectInstall GitFables CLI and create your first story
gitfables.config.json
JSON
{
"repository": {
"url": "https://github.com/user/repo",
"branch": "main"
},
"templates": {
"default": "technical-journey",
"customPath": "./templates"
},
"output": {
"format": "markdown",
"directory": "./stories"
}
}Configure your GitFables project settings
templates/technical-journey.yaml
YAML
---
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 }}Create a custom story template
4
Requirements
Make sure you have these prerequisites installed.
- Node.js 18 or higher
- Git 2.0 or higher
- A GitFables account
- Access to a Git repository
⚠️ Some features may require additional dependencies based on your use case.
5
Next Steps
After getting started, explore these advanced topics.
Advanced Features
- Custom templates
- Team collaboration
- API integration
- Automated workflows
Resources
- API documentation
- Example projects
- Community templates
- Best practices