npm.io
0.9.0 • Published 2d agoCLI

cadet-agent

Licence
CC-BY-4.0
Version
0.9.0
Deps
0
Size
20 kB
Vulns
0
Weekly
0
Stars
1

Cadet-Agent

Cadet-Agent is a cross-IDE agent framework for game-development workflows, with a shared framework core and authored root integrations for GitHub Copilot, Cursor, Continue, and Claude Code.

Repository Layout

  • .cadet/agent/core/ contains the shared Cadet-Agent framework documents.
  • .cadet/agent/docs/ contains setup guides for each supported IDE.
  • AGENTS.md contains shared top-level agent instructions.
  • .github/ contains GitHub Copilot-specific authored files.
  • .cursor/ contains Cursor-specific authored files.
  • .continue/ contains Continue-specific authored files.
  • .claude/ contains Claude Code-specific authored files.
  • package-agent.ps1 builds the distributable cadet-agent.zip package.
  • publish-npm.ps1 publishes the CLI to npm using a token from ~/.npm_token.

Quick Install

npx cadet-agent@latest init

This downloads the latest framework release and extracts it into your current directory. For a specific target directory:

npx cadet-agent@latest init --target ./my-unity-project

Manual Install

Download cadet-agent.zip from GitHub Releases and extract it into your Unity project root:

Expand-Archive .\cadet-agent.zip -DestinationPath . -Force

Getting Started

Examples

GitHub Copilot kickoff

Run npx cadet-agent@latest init in your Unity project root, then open the repo in VS Code and start a kickoff chat using the Cadet prompt.

/cadet Help me bootstrap a beginner-friendly 2D racing prototype in Unity with AI opponents and a career progression loop.

Cadet-Agent will use .github/prompts/cadet.prompt.md plus the shared framework in .cadet/agent/core to route the conversation through learner calibration, bootstrap checks, and planning.

Cursor feature request

After opening the repository in Cursor, the always-apply rule in .cursor/rules/cadet-agent.md should load automatically. A typical request looks like this:

Design a small vertical slice for a kart handling prototype in Unity. Start with requirements, then a technical design, then the first TDD task.

Cursor will use the Cadet rule to pull workflow, standards, and guidance from .cadet/agent/core before responding.

Continue planning request

With Continue installed in VS Code, open the repository and ask for a scoped planning artifact:

Create a requirements outline for a single-player time-trial mode with ghost replay support and Given/When/Then acceptance criteria.

The Continue rule in .continue/rules/cadet-agent.md should steer the response back through the shared Cadet framework.

Repository policy example

If a specific game repository needs local conventions, add a policy file under .cadet/agent/policies using .cadet/agent/core/Templates/PolicyTemplate.md. For example, a repository policy could define:

  • where project plans should live
  • where shared gameplay code should be extracted
  • which Unity packages or UI stack are the project default

Package Output

Running ./package-agent.ps1 produces cadet-agent.zip with this layout:

  • .cadet/agent/core/
  • AGENTS.md
  • .github/prompts/cadet.prompt.md
  • .cursor/rules/cadet-agent.md
  • .continue/rules/cadet-agent.md
  • .claude/skills/cadet-agent.md

Notes

  • .cadet/agent/core/FrameworkManifest.json defines the managed and preserved paths for packaged installs.
  • Repository-specific policy overlays belong in .cadet/agent/policies.
  • Planning artifacts belong in .cadet/agent/project-plans unless an active policy says otherwise.

Keywords