Documentation
Releases

v0.3.4 — Cursor and project descriptions

2026-11-04.

Record and recall project knowledge in Cursor, and keep the current project description in the README, docs page, or spec you already maintain.

Cursor

Initialize from the project root:

mini-trellis init -u your-name --cursor

Record confirmed conclusions with the mini-trellis-remember skill. Find relevant knowledge with mini-trellis mem recall, then use mem read when an excerpt is missing a condition.

Configuration preserves valid user command/prompt hooks, version values, and other fields. Invalid JSON or hook structure is kept and reported. refresh stops on a conflict; doctor explains invalid configuration or a missing mini-trellis startup registration.

The local startup entry is verified on Cursor 3.27.22. A successful hook log alone does not prove model delivery or use. When the entry is unavailable, use AGENTS.md, project skills, and mem recall. Cursor-managed cloud agents do not run sessionStart; self-hosted machines remain unverified. Cursor conversation history is not parsed.

One current project description

  • Update the existing README, docs page, or spec. Create a short spec only when none exists, and preserve the document’s language.
  • Check implemented capabilities against code or tests. Keep confirmed but unimplemented behavior and ideas separate. A constant or configuration value alone does not prove implementation.
  • Update the same description after a confirmed decision, then link the actual file from the journal. Keep symbol and path references current after a rename. A rename or formatting change alone does not add a journal entry.
  • add_session.py --topic accepts root README*.md files and Markdown under docs/ and doc/, while checking file existence and project scope. It validates the path and writes the journal; it does not update the topic text.

Migration and adding a host restore default rules when .trellis/.gitignore is missing. Existing user rules are preserved. Files already tracked by Git are not untracked.

Upgrade

Back up project knowledge and custom configuration, including Git-ignored files. For an existing mini-trellis project:

npm install -g mini-trellis@0.3.4
mini-trellis refresh --dry-run
mini-trellis refresh
mini-trellis doctor

refresh updates unmodified managed files and keeps project knowledge. Review any conflicts. Existing installations need both the new CLI and refreshed scripts and skills for the new topic paths and guidance. Then open a new chat.

For Trellis projects, preview with mini-trellis migrate --dry-run, confirm the migration, then initialize only the hosts you use. See Day to day and Migrate from Trellis.

Search documentation