Onboard

Knowledge Onboarding

Knowledge is a collection of instructions and advice that Opulent can reference in all sessions. Think of it as onboarding a new employee with the relevant organizational context.

Knowledge 101

Knowledge is the best way to share codebase-level (vs. task-level) context that helps Opulent work in your codebase. A few examples of what to put in Opulent's Knowledge: code conformance practices, deployment workflows, PR naming conventions, testing workflows, and how to interact with proprietary tools. These are the durable facts and rules Opulent recalls with memory_search — distinct from Memory (/dashboard/memory), which holds your preferences and collaboration state.

A few FYIs about Knowledge:

  • Opulent automatically generates repo Knowledge based on the existing READMEs, file structure, and contents of the connected repositories. If you don't give Opulent access to a repo, it won't generate any associated Knowledge.
  • Knowledge is retrieved based on the Trigger you set. The more specific the trigger (e.g. which file, repo, or type of task the Knowledge applies to), the better the retrieval. You can find more details here.
  • Opulent tells you in a session which Knowledge it used; you can see this under "Accessed Knowledge" in the session chat.
  • Opulent automatically pulls and updates Knowledge based on specialized files in your codebase including .rules, .mdc, .cursorrules, .windsurf, CLAUDE.md, and AGENTS.md. Note that Opulent won't automatically pull in more general file types like .md.

Knowledge Onboarding Best Practices

It's worth spending a little time upfront getting Opulent up to speed. Much like a new hire, sharing relevant context on the codebase and the workflows your team follows goes a long way toward making Opulent more effective. Recommended steps when you first set up Opulent's Knowledge:

  1. Review any auto-generated Knowledge and verify it for (a) completeness and (b) accuracy.
  2. If you want Opulent to retrieve a Knowledge note any time it's working on a session, pin it to all repositories. Otherwise, pin it to a specific repo if the information is only relevant in that context. If Knowledge isn't pinned, it's only used when triggered — so make sure your Trigger Description is clear.
  3. If you don't have a centralized specialized documentation file in your codebase, we recommend setting one up with a specialized file extension.
Info

Visit the Knowledge product guide for more details.