Skip to content

grcengineering/companion

Repository files navigation

The GRC Companion

v0.1.0

A learning companion for GRC practitioners. It turns real GRC work into structured learning loops and grounds that work in Ayoub Fandi's GRC engineering corpus.

The public site publishes the knowledge layer. The runtime lives in your local AI workspace.

31 knowledge cards, 14 skills, 4 adapter bundles.

Live pages:

  • Card index: https://grc.engineering/companion/
  • Install guide: https://grc.engineering/companion/install.html

Quickstart

  • Browse the public cards at https://grc.engineering/companion/.
  • Open the install guide at https://grc.engineering/companion/install.html.
  • The generated install source lives at docs/install.html.
  • Claude Code: dist/adapters/claude-code/companion/
  • Cursor: dist/adapters/cursor/.cursor/rules/companion.mdc
  • Claude Projects: dist/adapters/claude-projects/
  • Codex: dist/adapters/codex/

What Ships

  • 31 approved knowledge cards: 8 theses, 10 concepts, 4 metaphors, 4 anti-patterns, 5 reading references
  • 14 learning skills
  • 13 portable command contracts
  • A static public site built from the card corpus
  • Four installable adapter bundles: Claude Code, Cursor, Claude Projects, Codex

Public Surface

docs/ is a static GitHub Pages site. It has three public surfaces:

  • docs/index.html is the filterable card index.
  • docs/cards/<slug>.html is one public page per approved card.
  • docs/install.html is the concrete install guide.

The site has no backend. It does not process user artefacts.

Repository Shape

companion/
├── brain/          Companion persona, voice, learning method, primitives
├── knowledge/      Approved card corpus, glossary, frameworks, case studies
├── profile/        Learner-owned profile schema and examples
├── skills/         Learning skills only
├── commands/       Portable learning-only command contracts
├── demos/          Behavioural examples and transcripts
├── docs/           Generated public card index, card pages, and install guide
├── dist/adapters/  Generated platform bundles
└── scripts/        Build, verification, and corpus utilities

Boundary

The Companion is learning-only.

It can help a user learn from real vendor reviews, audit walkthroughs, policy work, control discussions, and terminal output. It should not approve vendors, certify audit positions, author production policies, run controls, or operate a programme.

Contributing

Local preview:

python3 -m http.server 8080 --directory docs

Then visit http://localhost:8080/.

Build and check loop:

scripts/build-knowledge-index
scripts/sync-skill-manifests
scripts/build-card-pages
scripts/build-adapters
scripts/verify-structure
scripts/run-evals

Generated outputs:

  • knowledge/index.json
  • docs/cards/*.html
  • docs/index.html
  • docs/install.html
  • docs/data/cards.json
  • dist/adapters/

Behaviour demo:

demos/run-terminal-demo

License

See LICENSE.

About

The GRC Companion turns vendor reviews, audit walkthroughs, questionnaires, policy work, control discussions, and terminal output into learning loops. It runs where you already use Claude or Codex, so your local work becomes the curriculum. Based on Ayoub Fandi's GRC Engineering corpus.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors