Configuration Guide
Configure GitFables to match your workflow.
1
Basic Configuration
Set up your basic GitFables configuration.
Create a gitfables.config.js file in your project root:
gitfables.config.js
JavaScript
module.exports = {
projectName: 'My Project',
repository: {
provider: 'github',
url: 'https://github.com/username/repo'
},
defaultBranch: 'main',
storyFormat: 'markdown'
}Basic GitFables configuration file
2
Environment Variables
Configure environment-specific settings.
Add these variables to your .env file:
.env
Bash
GITFABLES_API_KEY=your_api_key_here
GITFABLES_ENVIRONMENT=development
GITFABLES_LOG_LEVEL=debugEnvironment variables configuration
3
Story Templates
Configure your story generation templates.
Create a templates directory with your custom templates:
project-structure
Bash
templates/
├── commit-story.md
├── release-notes.md
└── weekly-summary.mdTemplate directory structure
Templates support variables and custom formatting options.
4
Advanced Settings
Fine-tune GitFables behavior.
advanced-settings.json
JSON
{
"ai": {
"model": "gpt-4",
"temperature": 0.7,
"maxTokens": 2048
}Advanced AI configuration settings
Next Steps
Explore these resources to customize GitFables further.