Skip to content

docs: update README with project overview #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TonyCasey merged 1 commit into from
Feb 13, 2026
+24 −4
Merged

docs: update README with project overview #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,40 @@
# Git Mem

Your git history is the PERFECT context for AI tools.
Your git history is the perfect context for AI.
It just needs to be extracted for agents....

## Why?

Every commit message, every PR description — it's all there.
Your git history already contains the decisions, conventions, and gotchas that matter — git-mem extracts them and makes them available to Claude automatically.

IT JUST NEEDS TO BE FREED !!!
## How?

When initialized in your repo, git-mem reviews your last (n) commits and extracts knowledge automatically.
Each commit is updated with background AI metadata, which Claude can use to improve its understanding of your codebase.

Every **new** commit is automatically populated with the folowing metadata..
Copy link

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling error: "folowing" should be "following"

Suggested change
Every **new** commit is automatically populated with the folowing metadata..
Every **new** commit is automatically populated with the following metadata..

Copilot uses AI. Check for mistakes.

- **AI-Agent:** Claude/Opus-4.5
Copy link

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The AI-Agent value format "Claude/Opus-4.5" is inconsistent with how the prepare-commit-msg hook actually sets this trailer. The hook uses "Claude-Code" (with a hyphen, not a slash) when the CLAUDE_CODE environment variable is set. Consider using a more realistic example like "AI-Agent: Claude-Code" to match the actual implementation in src/hooks/prepare-commit-msg.ts:42.

Suggested change
- **AI-Agent:** Claude/Opus-4.5
- **AI-Agent:** Claude-Code

Copilot uses AI. Check for mistakes.
- **AI-Decision:** JWT over sessions — stateless API, scales horizontally
- **AI-Context:** [pattern/middleware, entity/auth-module]
Copy link

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The trailer key "AI-Context" does not exist in the codebase. The actual AI-* trailer keys defined in src/domain/entities/ITrailer.ts are: AI-Decision, AI-Gotcha, AI-Convention, AI-Fact, AI-Confidence, AI-Tags, AI-Lifecycle, AI-Memory-Id, and AI-Agent. Consider using AI-Tags instead, which is designed for categorization metadata like "pattern/middleware" or "entity/auth-module".

Suggested change
- **AI-Context:** [pattern/middleware, entity/auth-module]
- **AI-Tags:** [pattern/middleware, entity/auth-module]

Copilot uses AI. Check for mistakes.
- **AI-Confidence:** 0.95
Copy link

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The AI-Confidence value format is incorrect. Confidence values in git-mem are string-based enums, not numeric values. According to src/domain/types/IMemoryQuality.ts:25, valid confidence levels are: 'verified', 'high', 'medium', 'low', or 'uncertain'. The example should use something like "AI-Confidence: high" instead of "AI-Confidence: 0.95".

Suggested change
- **AI-Confidence:** 0.95
- **AI-Confidence:** high

Copilot uses AI. Check for mistakes.
- **AI-Memory:** milestone/auth-implementation
Copy link

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The trailer key "AI-Memory" does not exist in the codebase. The actual AI-* trailer keys defined in src/domain/entities/ITrailer.ts are: AI-Decision, AI-Gotcha, AI-Convention, AI-Fact, AI-Confidence, AI-Tags, AI-Lifecycle, AI-Memory-Id, and AI-Agent. If you meant to show a memory identifier, the correct key is "AI-Memory-Id". However, AI-Memory-Id typically contains UUIDs (e.g., "550e8400-e29b-41d4-a716-446655440000"), not semantic strings like "milestone/auth-implementation". For lifecycle metadata, use "AI-Lifecycle" instead (with values like "permanent", "project", or "session").

Suggested change
- **AI-Memory:** milestone/auth-implementation
- **AI-Tags:** milestone/auth-implementation

Copilot uses AI. Check for mistakes.

Going forward, AI knowledge will be embedded in each commit for future references

---

## Install

```bash
npm install -g git-mem
cd your-repo
git-mem init
```

See the [Getting Started Guide](./docs/getting-started.md)
`init` sets up hooks, MCP config, .gitignore entries, and runs an initial extract from your history.

See the [Getting Started Guide](./docs/getting-started.md) for full CLI and MCP setup docs.

## License

Expand Down