Skip to main content

Durable engineering memory CLI: doctor, reindex, find, recall, synthesize, MCP, and QA test-plan generation.

Project description

Braingent Memory Repo

This is a Markdown-first engineering memory repository based on Braingent, created by JJ Adonis.

Use it as a durable memory layer for AI-assisted software engineering work. Claude, Codex, ChatGPT, and other tools should read this repo before planning meaningful work and should capture important outcomes after the work is done.

What Goes Here

  • Project and repository profiles.
  • Task records.
  • Code review records.
  • Decision records.
  • Reusable learnings.
  • Tool and version notes.
  • Ticket stubs for cross-cutting work.
  • Optional live BGT-NNNN agent tasks for active coordination.
  • Optional dashboard docs for a read-only live task UI.
  • An installable braingent helper CLI for search, validation, reindexing, task files, MCP retrieval, and QA generation.
  • The packaged QA generator for Markdown, Xray JSON, TestRail CSV, and Gherkin outputs.
  • Raw imports before they are summarized.
  • Preferences that guide future AI agents.

Read First

Agents should start here:

  1. AGENTS.md or CLAUDE.md, depending on the tool.
  2. INDEX.md.
  3. CURRENT_STATE.md.
  4. preferences/.
  5. tasks/INDEX.md if live tasks are enabled and the work may already be active.
  6. Relevant organization, project, repository, topic, tool, ticket, or person records.

Core Workflow

Before work:

  • Read the root instructions.
  • Search memory for relevant context.
  • Check live tasks before creating overlapping active work.
  • Reuse prior decisions and conventions.

During work:

  • Track decisions, versions, commands, failures, fixes, tickets, PRs, branches, and follow-ups.
  • Append activity to a live BGT-NNNN task when coordination or handoff matters.

After work:

  • Create or update a durable record.
  • Link completed live tasks to durable records with agent_task: BGT-NNNN.
  • Update indexes or current state if needed.
  • Commit the memory change.

Search

Start with free-text search:

rg -n "<query>" .

Use the packaged structured search helper:

braingent find kind=decision
braingent recall repo=repo--example--owner--repo

You can also search frontmatter fields directly:

  • record_kind
  • status
  • organization
  • project
  • repositories
  • ticket
  • topics
  • tools
  • people
  • ai_tools

Safety

Never store secrets, credentials, tokens, private keys, customer secrets, or sensitive personal data in this repo.

Use placeholders and links instead of copying sensitive evidence.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

braingent-0.1.0.tar.gz (101.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

braingent-0.1.0-py3-none-any.whl (147.0 kB view details)

Uploaded Python 3

File details

Details for the file braingent-0.1.0.tar.gz.

File metadata

  • Download URL: braingent-0.1.0.tar.gz
  • Upload date:
  • Size: 101.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for braingent-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a95e7e87eab64aec50fde9517f2dc4699b9fe994032ac6612e38119a0397faa8
MD5 775c83d5b18ec5b078d06a5106da68d5
BLAKE2b-256 3988355d8a22283c80b55c3ab5814e6cf5cae7bb35fb5a7b339c07030e12901f

See more details on using hashes here.

Provenance

The following attestation bundles were made for braingent-0.1.0.tar.gz:

Publisher: publish-pypi.yml on thedoublejay/braingent-manifesto

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file braingent-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: braingent-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 147.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for braingent-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3f77f984872246c18677e4058af76c85f0de03c8746cf988e4691d6174c2aa75
MD5 3298133f5554f9bd6f89d02d43da3150
BLAKE2b-256 8410eb84ee889358677526d124d3d8a0ddf85ac9a4b1374dd6e7b270305b1fed

See more details on using hashes here.

Provenance

The following attestation bundles were made for braingent-0.1.0-py3-none-any.whl:

Publisher: publish-pypi.yml on thedoublejay/braingent-manifesto

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page