Documentation

Learn how to use CommitLore's /lore command to automatically generate social media content from your commits.

Quick Start

Add /lore anywhere in your commit message to trigger content generation:

git commit -m "feat: add dark mode support /lore"

CommitLore will automatically generate content for all your connected platforms (Twitter, LinkedIn, WordPress, Dev.to).

Command Syntax

/lore[:platforms] [--tone=value] [--personality=value] [--skip-files=true]

All parameters are optional. The command can appear anywhere in your commit message.

Supported Platforms

Specify one or more platforms to generate content for specific channels:

PlatformAliasesDescription
twittertw, xGenerate tweet (280 characters)
linkedinliGenerate LinkedIn post
wordpresswpGenerate WordPress blog post
devtodevGenerate Dev.to article

Note: When no platforms are specified, content is generated for all connected platforms.

Tone Options

Control the voice and style of your generated content:

casual

Relaxed, conversational tone. Great for Twitter.

professional

Polished, business-appropriate. Ideal for LinkedIn.

technical

Detailed, precise language for developer audiences.

enthusiastic

Energetic and excited. Perfect for big announcements.

friendly

Warm and approachable. Good for community building.

Personality Options

Define the character of your content:

witty

Clever and humorous. Adds personality to updates.

serious

Straightforward and factual. No-nonsense approach.

friendly

Warm and personable. Builds connection with audience.

technical

Detail-oriented and precise. For technical audiences.

storyteller

Narrative-driven. Weaves updates into engaging stories.

Additional Options

--skip-files=true

Skip file contents when generating content. Useful for:

  • Large commits with many file changes
  • When you only want to use the commit message
  • Privacy-sensitive changes

Examples

Basic Usage

Generate content for all platforms:

feat: add user authentication /lore

Single Platform

Generate only a tweet:

fix: resolve memory leak in dashboard /lore:twitter

Multiple Platforms

Generate for Twitter and LinkedIn:

feat: launch v2.0 with new dashboard /lore:tw,li

With Tone

Professional tone for LinkedIn:

feat: implement enterprise SSO /lore:linkedin --tone=professional

With Personality

Witty tweet for fun updates:

fix: finally squash that pesky bug /lore:x --personality=witty

Full Configuration

Combine platforms with tone and personality:

feat: add real-time notifications /lore:twitter,linkedin --tone=enthusiastic --personality=friendly

Skip File Contents

Generate based on message only:

refactor: restructure entire codebase /lore --skip-files=true

Technical Blog Post

Generate a detailed Dev.to article:

feat: implement custom caching layer /lore:devto --tone=technical --personality=technical

In Commit Body

Place command in the commit body:

feat: add payment integration Implemented Stripe checkout flow with: - Subscription management - Invoice generation - Webhook handling /lore:linkedin,wordpress --tone=professional

Best Practices

Do

  • Write descriptive commit messages
  • Match tone to platform audience
  • Use platform aliases for shorter commands
  • Skip files for large refactors
  • Use storyteller for milestone commits
  • Review generated content before publishing

Don't

  • Use /lore for every commit
  • Include sensitive data in messages
  • Forget to connect platforms first
  • Mix incompatible tone + personality
  • Add /lore to merge commits
  • Use for work-in-progress commits

How It Works

1

Push your commit

Include /lore in your commit message and push to GitHub.

2

Webhook triggers

CommitLore receives the webhook and parses your /lore command.

3

AI generates content

Our AI analyzes your commit and generates platform-optimized content.

4

Review in drafts

Content appears in your dashboard drafts, ready for review and publishing.

Frequently Asked Questions

What if I forget to add /lore?

No content will be generated. You can manually create content from your dashboard by selecting commits.

Can I use /lore in amended commits?

Yes, but only if you force push. The webhook triggers on push events, so the amended commit with /lore will be processed.

Does the /lore command appear in my published content?

No, the command is automatically stripped from your commit message before content generation.

How long does content generation take?

Usually 10-30 seconds depending on the number of platforms and complexity of the commit.

Does it count against my plan limits?

Yes, each commit with /lore counts as one generation toward your monthly limit.

Need Help?

If you have questions or need assistance, we're here to help: