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 active-task's remaining unchecked steps at the start of every session.
  • PreCompactengaku inject: injects the full task body (Background, Design, File Map, and all checkbox lines) before conversation compaction so the compact model retains full task context.
  • UserPromptSubmitengaku prompt-check: scans each user prompt for new rules or constraints and injects all remaining unchecked task 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.8.0.tar.gz (35.0 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.8.0-py3-none-any.whl (36.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for engaku-0.8.0.tar.gz
Algorithm Hash digest
SHA256 5a3d6ea7ae57faf6170d7928870e6416336718c6b5e7dab2c67f77f2f4e4df1b
MD5 c0b14b1c763babddc4a5c14e22c19b09
BLAKE2b-256 733fcb09de566a7cedf103b38523ea277682bd1810d84b3b0195b8f5e3df6e5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for engaku-0.8.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.8.0-py3-none-any.whl.

File metadata

  • Download URL: engaku-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 36.1 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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 203cb0abdcdaa2c1a4f95ec0abd55b8af108c8be1e01252cd1d1b8b12a8056f7
MD5 35452fc78caa5f6a82598145580e597c
BLAKE2b-256 ac5545fd843537a13c654180faf7e9bf6bc8dd52d9ae6707b6680a0227bb15b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for engaku-0.8.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