Skip to main content

AI persistent memory layer for VS Code Copilot

Project description

engaku

AI persistent memory layer for VS Code Copilot — keeps project context, rules, and active tasks in front of the agent at every turn through VS Code Agent Hooks.

What it does

engaku gives VS Code Copilot durable project memory stored in .ai/ Markdown files. Agent Hooks automatically inject current context into every conversation, surface active-task steps on each prompt, and remind the agent when a task plan is complete and ready for review.

Installation

pip install engaku

Or install directly from source:

pip install git+https://github.com/JorgenLiu/engaku.git

Quick Start

# Bootstrap .ai/ and .github/ structure in your repo
engaku init

After running init, VS Code Agent Hooks are active. The @dev, @planner, @reviewer, and @scanner agents are available via .github/agents/. No further manual steps are needed — hooks fire automatically on SessionStart, UserPromptSubmit, Stop, and PreCompact.

What engaku init creates

.ai/
  overview.md       — project description, constraints, tech stack
  tasks/            — planner-managed task plans
  decisions/        — architecture decision records
.github/
  copilot-instructions.md   — global agent rules
  agents/           — dev, planner, reviewer, scanner agent definitions
  instructions/     — .instructions.md stubs for hooks, templates, tests
  skills/           — bundled skills (systematic-debugging, verification-before-completion, frontend-design)

Subcommands

Command Purpose
init Bootstrap .ai/, .github/ structure and install VS Code Agent Hooks
inject Inject .ai/overview.md + active-task context (SessionStart / PreCompact hook)
prompt-check Detect rule/constraint in user prompt and inject active-task steps (UserPromptSubmit hook)
task-review Detect completed task plans and emit handoff reminder (Stop hook)
apply Apply .ai/engaku.json model config to .github/agents/ frontmatter

How it works

After engaku init, four Agent Hooks fire automatically:

  • SessionStartengaku inject: injects overview.md and the current active-task context at the start of every session.
  • PreCompactengaku inject: re-injects context before conversation compaction so the agent doesn't lose project memory.
  • UserPromptSubmitengaku prompt-check: scans each user prompt for new rules or constraints and injects the active-task's unchecked steps as a system message so the agent always knows what to do next.
  • Stopengaku task-review: after each agent turn, checks whether all steps in an in-progress task plan are ticked and emits a handoff reminder if so.

Requirements

  • Python ≥ 3.8 (stdlib only, no third-party dependencies)
  • VS Code with GitHub Copilot

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

engaku-0.5.0.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

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

engaku-0.5.0-py3-none-any.whl (34.8 kB view details)

Uploaded Python 3

File details

Details for the file engaku-0.5.0.tar.gz.

File metadata

  • Download URL: engaku-0.5.0.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for engaku-0.5.0.tar.gz
Algorithm Hash digest
SHA256 83ae3aedacb5aea9f5f6b5d7a1cb094de832ed5bfca81a88ba2f4a1452c32db2
MD5 1cce3d1ffb85aaea2728d9d5bf975180
BLAKE2b-256 1fee8fb502396642ee15a907b317f15f584f1bac263bc891281dec8ad58f0dc4

See more details on using hashes here.

Provenance

The following attestation bundles were made for engaku-0.5.0.tar.gz:

Publisher: publish.yml on JorgenLiu/engaku

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

File details

Details for the file engaku-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: engaku-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 34.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for engaku-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 95cfdc418c84463998f7c3b8ae9a065b14e560b42bedebfc07a369aa30ba9188
MD5 f4ee74d855ddd310ccf7071e240aba33
BLAKE2b-256 e2597674ae9fe4b2c4cdcd7df09fca8b1ed36be9d39f787369cc1e2e58a6ce1f

See more details on using hashes here.

Provenance

The following attestation bundles were made for engaku-0.5.0-py3-none-any.whl:

Publisher: publish.yml on JorgenLiu/engaku

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