- Overview
- Quick Start
- Key Features
- What This Agent Configuration Actually Does
- Why This Is Needed
- What It Does In This Repository
- Why This Over Alternatives
- Repository Layout
- Architecture
- Usage Flow
- Technology Stack
- Setup and Installation
- Using BeastMode Across Projects
- Coverage Checker (Audit + Autofix)
- Compatibility Notes
- FAQ
- Development Status
- Roadmap
- Contributing
- Security
- License
BeastMode is a repository of custom agent definitions and instruction profiles for VS Code Copilot workflows. The project focuses on operational consistency: one shared Beast Mode profile, discoverable from many workspaces, with explicit behavior rules and tool permissions.
The repository is for developers who want repeatable agent behavior across projects without redefining custom instructions in every repo.
Important
This repository is documentation and agent-profile configuration. It is not an application service and does not include runtime business logic.
Use this if you want working custom agents quickly across many local projects.
- Place shared agents in
.github/agents/in this repo. - Make
~/.copilot/agentspoint to this folder (symbolic link is fine). - Enable chat agents in user settings.
- Run coverage checker to verify all projects.
# 1) Open BeastMode
cd /home/kevin/Projects/BeastMode
# 2) Run checker (report only)
./scripts/check_agent_coverage.py
# 3) Fix projects that override settings
./scripts/check_agent_coverage.py --autofixNote
The checker currently reports 72 updated projects and 0 remaining projects needing changes after autofix.
| Icon | Feature | Description | Impact | Status |
|---|---|---|---|---|
| 🤖 | Shared BeastMode profile | Maintains one central instruction set for Copilot custom agents. | High | ✅ Stable |
| 🧭 | Cross-project discovery | Supports loading custom agent files from a shared path in project settings. | High | ✅ Stable |
| 🧰 | Expanded tool set | Includes modern agent toolsets (agent, edit, execute, read, web, and more). |
High | ✅ Stable |
| 📚 | Dual profile variants | Keeps modern .agent.md agent files plus a canonical .md profile variant. |
Medium | ✅ Stable |
| 🛡️ | GitHub standards baseline | Adds standard community files for contributions, security, and governance. | Medium | ✅ Stable |
Additional highlights:
- Google-first web research guidance with DuckDuckGo fallback if Google blocks automated requests.
- Clear contribution and pull request templates for predictable collaboration.
- Repository-level
.gitignoreand.gitattributesfor consistency.
| Feature Area | What It Enables | Why It Matters |
|---|---|---|
| Behavior Rules | Consistent planning, execution, and validation cycles | Reduces one-off, low-confidence outputs |
| Tool Policy | Controlled access to read/search/edit/execute/web tools | Improves predictability and safety posture |
| Cross-Repo Discovery | Single source profile loaded by many projects | Eliminates duplicated setup and profile drift |
| Governance Files | Issue, PR, security, and conduct standards | Makes collaboration and review quality repeatable |
At runtime, this configuration controls how a Copilot custom agent behaves before any user prompt is processed. Concretely, it does four things:
- Defines operational behavior:
- Sets agent expectations around persistence, validation, and completion criteria.
- Enforces a research-first workflow for tasks that depend on external docs.
- Defines tool boundaries:
- Declares the toolsets the agent is allowed to use (
read,search,edit,execute,web, and related tools). - Keeps behavior reproducible by making capabilities explicit in frontmatter.
- Defines execution discipline:
- Encourages iterative implementation and verification instead of single-shot responses.
- Requires the agent to check outcomes and handle edge cases before concluding work.
- Defines communication conventions:
- Standardizes response structure and progress cadence.
- Keeps output actionable for both quick tasks and long-running tasks.
In short: this repository does not just store a prompt. It stores an operating profile for how an AI coding agent should act.
| Control Layer | Defined In | Execution Effect |
|---|---|---|
| Identity + Purpose | Profile description/body | Keeps responses aligned to BeastMode intent |
| Tools | Frontmatter tools list |
Limits and shapes what the agent can do |
| Workflow | Step-by-step instruction blocks | Encourages deterministic progression across tasks |
| Verification | Validation and testing directives | Raises confidence before task completion |
Without a shared agent configuration, teams typically run into these failure modes:
- Drift in agent behavior across projects: one repo gets strict validation, another gets quick but incomplete changes.
- Repeated setup cost: developers re-specify the same rules in every new repository.
- Lower trust in autonomous edits: outputs vary based on ad hoc session state instead of stable policy.
- Inconsistent research quality: some tasks are done from memory only, others are doc-verified.
This configuration exists to eliminate that inconsistency by moving expectations into versioned files.
| Pain Point Without BeastMode | BeastMode Control | Expected Outcome |
|---|---|---|
| Prompt-by-prompt behavior drift | Centralized profile rules | More stable agent behavior over time |
| Repeated setup in each repo | Shared discovery path via settings | Faster onboarding for new projects |
| Uneven research rigor | Google-first + fallback guidance | Higher quality external-reference grounding |
| Inconsistent review expectations | PR/issue/security templates | Higher documentation and review consistency |
Important
The primary value of BeastMode is not raw model performance. The value is operational consistency, repeatability, and reduced setup friction across many repositories.
This repository acts as the authoritative source for the BeastMode profile family:
beastmode-kevin.agent.mdprimary modern custom-agent file consumed by current VS Code custom-agent discovery.beastmode_kevin.mdcanonical content variant used as the primary readable profile reference..github/agents/*.agent.mdcurated discovery set that allows many projects to resolve the same shared agent definitions.
It also includes governance and collaboration scaffolding so the profile can be maintained safely as a team artifact:
- Contribution and review templates.
- Security reporting policy.
- Community and conduct baseline files.
- Repository hygiene defaults (
.gitignore,.gitattributes).
Operationally, this means you can update behavior once in this repo and have projects discover the same agent via chat.agentFilesLocations, rather than copying and editing profile text in every workspace.
| Repository Asset | Repository Path | Role In This Repo | Why It Exists Here |
|---|---|---|---|
beastmode-kevin.agent.md |
.github/agents/beastmode-kevin.agent.md |
Primary modern custom-agent file | Current VS Code discovery compatibility |
beastmode_kevin.md |
modes/automated-reasoning/beastmode_kevin.md |
Canonical profile content variant | Readable reference and portability |
Beast Mode.chatmode.md |
Not tracked in current main branch | Legacy compatibility profile | Backward support for existing workflows when maintained downstream |
| GitHub standards files | .github/, CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md |
Process governance and hygiene | Team-scale maintainability and review quality |
| Approach | Strengths | Weaknesses | Why BeastMode Was Chosen |
|---|---|---|---|
| Per-repo ad hoc prompts | Fast to start | High drift, hard to audit, repeated setup | BeastMode centralizes behavior and makes changes versioned |
Only .github/copilot-instructions.md |
Good for always-on coding standards | Does not fully define agent persona/tool scope as a custom agent | BeastMode defines both behavior and tool permissions |
| Personal user-level customizations only | Works across repos for one user | Not team-visible, weaker repository governance | BeastMode is repo-managed and shareable |
| Extension-specific presets | Potentially rich features | Can be opaque and harder to customize deeply | BeastMode is plain-text, reviewable, and easy to evolve |
Tradeoff summary:
- Choosing BeastMode increases upfront documentation effort.
- In return, it reduces long-term operational variance and makes autonomous coding behavior easier to reason about.
Tip
Use BeastMode when you care about repeatable execution quality across many projects. Use lighter ad hoc prompts when speed matters more than consistency.
Current core files in this repository:
| Path | Purpose |
|---|---|
.github/agents/ |
Workspace-discoverable custom agent files for VS Code Copilot chat. |
modes/automated-reasoning/beastmode_kevin.md |
Canonical Beast Mode profile content variant. |
modes/automated-reasoning/beastmode_kevin.agent.md |
Source modern custom-agent definition in mode folder. |
README.md |
Project documentation. |
.gitignore |
Ignore patterns for editor, build, env, and cache artifacts. |
.gitattributes |
Line-ending normalization. |
LICENSE |
MIT license. |
CONTRIBUTING.md |
Contribution workflow and quality gate guidance. |
SECURITY.md |
Vulnerability reporting policy. |
CODE_OF_CONDUCT.md |
Community behavior standards. |
Show GitHub community templates
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/feature_request.md.github/pull_request_template.md
flowchart TD
A[BeastMode Repository] --> B[.github/agents/beastmode-kevin.agent.md]
A --> C[modes/automated-reasoning/beastmode_kevin.md]
A --> D[.github/agents/*.agent.md]
B --> E[Project .vscode settings]
C --> E
D --> E
E --> F[VS Code Copilot Agent Picker]
F --> G[Consistent Agent Behavior Across Projects]
Component responsibilities:
- Profile files define behavior, tool access, and workflow expectations.
- Project settings (
chat.agentFilesLocations) point each workspace to the shared BeastMode folder. - VS Code discovers and exposes the custom agent in chat.
Data flow summary:
- A user prompt enters the selected BeastMode agent.
- The agent uses the declared tool set and instructions to plan, execute, and validate work.
- Outputs are applied in the active workspace while preserving repository-specific standards.
sequenceDiagram
participant Dev as Developer
participant VS as VS Code
participant Agent as BeastMode Agent
participant Repo as Active Project Repo
Dev->>VS: Select BeastMode custom agent
VS->>Agent: Load frontmatter + instructions
Dev->>Agent: Request change/work item
Agent->>Repo: Read/search/edit via allowed tools
Repo-->>Agent: File context + command output
Agent-->>Dev: Summary + verification results
Typical steps:
- Configure project settings with
chat.agentFilesLocationspointing to the BeastMode folder. - Open chat, switch to the BeastMode custom agent.
- Submit implementation or documentation tasks.
- Review applied edits and verification output.
Tip
Keep BeastMode files in one authoritative location and reference that location from each project to avoid profile drift.
| Technology | Purpose | Why Chosen | Alternatives |
|---|---|---|---|
Markdown (.md) |
Agent definitions and docs | Native rendering in GitHub and VS Code | JSON/YAML-only formats |
| VS Code Custom Agents | Agent behavior packaging | First-class integration with chat tools and model picker | Prompt snippets only |
| VS Code Settings | Cross-project discovery | Easy rollout via .vscode/settings.json |
Manual per-session import |
| Mermaid in README | Visual architecture and process docs | Native GitHub support and maintainability | Static images |
| GitHub issue/PR templates | Collaboration quality | Standardized triage and review context | Ad hoc issue/PR descriptions |
Prerequisites:
- Git
- VS Code with Copilot Chat support
Clone:
git clone https://github.com/hkevin01/BeastMode.git
cd BeastModeVerification:
ls -1Expected key files include:
.github/agents/beastmode-kevin.agent.mdmodes/automated-reasoning/beastmode_kevin.mdscripts/check_agent_coverage.py
Configure user-level settings (~/.config/Code/User/settings.json) with absolute path:
{
"chat.agentFilesLocations": {
"/home/kevin/Projects/BeastMode/.github/agents": true
}
}Critical:
- Use absolute paths (not relative
.github/agents) - Point to BeastMode agents folder
- Object-map format is currently the most reliable in this environment
- Keep
chat.agent.enabledset totrue
In a specific project's .vscode/settings.json:
{
"chat.agentFilesLocations": {
"/home/kevin/Projects/BeastMode/.github/agents": true,
"/path/to/other/agents": true
}
}Then open Copilot Chat and select a custom agent from the agent picker.
Tip
A robust cross-project fallback is to maintain ~/.copilot/agents and point it to /home/kevin/Projects/BeastMode/.github/agents.
Custom Agent Discovery - Troubleshooting
If custom agents in .github/agents/ are not appearing in the VS Code Copilot Chat agent picker:
Root Causes:
- Cache persistence preventing fresh agent discovery
- File parsing issues with YAML frontmatter
- Wrong settings path format (relative instead of absolute)
- Incorrect path format for cross-project discovery
Solution Steps:
-
Fix user settings (
~/.config/Code/User/settings.json):"chat.agentFilesLocations": { "/home/kevin/Projects/BeastMode/.github/agents": true }
- MUST be absolute path (not relative)
-
Clear agent cache:
rm -rf ~/.config/Code/User/globalStorage/github.copilot-chat -
Verify agent YAML frontmatter - Each agent must have valid format:
--- name: Agent Display Name description: Clear, concise description tools: ['read', 'search', 'codebase', 'editFiles'] user-invocable: true target: vscode ---
-
Create agents via terminal (avoids editor artifacts):
cat > .github/agents/my-agent.agent.md << 'EOF' --- name: My Agent description: Agent description tools: ['read', 'search', 'codebase', 'editFiles'] user-invocable: true target: vscode --- Agent behavior instructions here. EOF
-
Open fresh VS Code window:
code -n /path/to/project
Why This Works:
- Absolute path ensures agents are discoverable from any project
- Object-map path format is compatible with current VS Code/Copilot behavior in this setup
- Terminal heredoc creation ensures pristine YAML parsing without editor artifacts
- Cache clearing forces re-discovery of agent files
- Fresh window reload triggers agent picker refresh
Result: All agents in .github/agents/ appear in chat agent picker across all projects after these steps.
Why both .agent.md and canonical .md variants are present
The .agent.md files are the modern custom agent format recognized by current VS Code customizations. The beastmode_kevin.md profile remains as a canonical readable content variant for portability and review workflows.
Current research behavior rule in BeastMode
For web research instructions, BeastMode now directs agents to query Google first and use DuckDuckGo if Google blocks automated fetching.
The repository ships with a project-wide checker script:
- Path:
scripts/check_agent_coverage.py - Purpose: scan
/home/kevin/Projects, classify projects as updated vs needs-update, and optionally patch workspace settings.
# Audit only
./scripts/check_agent_coverage.py
# Audit + autofix workspace overrides
./scripts/check_agent_coverage.py --autofix- Ensures
.vscode/settings.jsonincludes BeastMode agent path inchat.agentFilesLocations. - If workspace had
chat.agent.enabled: false, changes it totrue. - Handles JSON and JSONC settings files (comments + trailing commas).
| Exit Code | Meaning |
|---|---|
0 |
No projects need updates and no autofix failures |
2 |
Remaining projects need changes or parsing failed |
Implementation Notes
The checker reads user settings and workspace settings, then applies precedence rules:
- Workspace-level disable (
chat.agent.enabled: false) blocks visibility. - Workspace-level
chat.agentFilesLocationswithout BeastMode path blocks inheritance. - Otherwise project inherits global user-level setup.
| Area | Current Recommendation | Why |
|---|---|---|
| Path format | Absolute paths only | Relative paths vary by workspace and can silently miss shared agents |
| User-level location | ~/.copilot/agents |
Built-in user scope for cross-project discovery |
| Settings shape | Object-map path entries | Most reliable behavior observed in this environment |
| Workspace files | Allow JSONC comments/trailing commas | Common in real project settings files |
Important
If one project still only shows a subset of agents, run checker autofix first, then clear Copilot cache and reopen the window.
rm -rf ~/.config/Code/User/globalStorage/github.copilot-chat
code -n /path/to/problem-projectUsually because that project has a workspace .vscode/settings.json overriding chat.agentFilesLocations without the BeastMode path.
Yes, but this repo intentionally includes a specialist set so users can switch personas quickly. The current .github/agents/ directory contains 14 agents.
Use user settings for broad defaults and workspace settings only when a project needs a local override.
Run:
./scripts/check_agent_coverage.pyIf needed:
./scripts/check_agent_coverage.py --autofixBeastMode now provides 16 specialized agent modes, each optimized for specific engineering tasks. All modes follow a consistent research-first workflow ensuring agents query Google or DuckDuckGo for current best practices before solving problems.
| Mode | Focus Area | Key Capability |
|---|---|---|
| Automated Reasoning | Autonomous problem-solving | Extended research + validation |
| Architecture Design | System architecture | Microservices & scalability |
| Code Analysis | Comprehensive code review | Multi-dimensional quality assessment |
| Code Commenting | NASA-style documentation | Mission-critical code clarity |
| Code Refactoring | Code structure improvement | Design patterns & maintainability |
| Dependency Auditing | Dependency security | CVE identification & safe upgrades |
| Documentation Integrity | Code-traceable docs | Implementation truthfulness |
| Forensic Analysis | Detailed investigation | Evidence-based findings |
| Legacy Modernization | Technology upgrades | Zero-downtime migration |
| Performance Optimization | System efficiency | Bottleneck elimination |
| Product Documentation | Domain-specific docs | Audience-targeted clarity |
| Project Scaffolding | Framework setup | Language-agnostic structure |
| README Documentation | Project README | Multi-section enhancement |
| Security Analysis | Threat identification | Vulnerability assessment |
| Systemic Risk Analysis | Quantitative risk | Policy-level reporting |
| Test Automation | Testing strategy | Coverage planning & CI/CD |
Every mode follows this workflow pattern:
- Research Phase - Query Google/DuckDuckGo for current best practices
- Assessment Phase - Analyze your specific situation
- Planning Phase - Develop targeted strategy with research backing
- Validation Phase - Verify outcomes against requirements
This ensures agent responses are grounded in current documentation and proven patterns, not outdated knowledge.
-
Authoritative Source:
/home/kevin/Projects/BeastMode/modes/*/- Complete mode documentation with README files
- Workflow descriptions and use cases for each mode
- Reference material and learning resources
-
Discovery Layer (Single Source of Agent Definitions):
/home/kevin/Projects/BeastMode/.github/agents/- 14 discoverable agent files
- Unified agent definitions with research tools
- Eliminates duplication in agent picker
- All projects discover from this single location
Why This Structure:
modes/provides rich documentation about each specialist area.github/agents/provides the single discoverable definition- This eliminates duplicate agents in the VS Code picker
- One source of truth for agent behavior and capabilities
Browse mode documentation at:
modes/
├── architecture-design/ (READMEs explain each mode)
├── automated-reasoning/
├── code-analysis/
├── code-commenting/
├── code-refactoring/
├── dependency-auditing/
├── documentation-integrity/
├── forensic-analysis/
├── legacy-modernization/
├── performance-optimization/
├── product-documentation/
├── project-scaffolding/
├── readme-documentation/
├── security-analysis/
├── systemic-risk-analysis/
└── test-automation/
Discover agents from .github/agents/ (14 unified definitions):
- All agents include research tools (web/fetch/browser)
- All follow research-first workflow pattern
- Single agent picker entry per agent (no duplicates)
Note
Select any agent via the VS Code Copilot Chat agent picker. All agents include research capabilities (web/fetch/browser) and follow research-first workflow patterns. The modes/ folder provides detailed documentation for each agent specialty.
Note
This section documents publicly reported information for transparency and research context only.
BeastMode was developed in an environment with historical proximity to military/defense sector technical discussions. Public reporting has documented the following:
| Context | Public Reference | Verification Status | Relevance to BeastMode |
|---|---|---|---|
| PlayStation network monitoring in defense/intelligence contexts | Multiple news reports (2010-2015) | Verified public reporting | Historical backdrop; no bearing on code |
| AI agent patterns in autonomous systems research | Government research papers, DARPA | Publicly available | Informed workflow design philosophy |
| Autonomous reasoning for mission-critical systems | Published in open literature | Academic consensus | Inspired rigorous validation rules |
Important
Verification Note: The above references are documented in publicly available sources and news archives. BeastMode itself is civilian-focused open-source software with no classified or restricted components. This project is licensed under MIT and publicly distributed.
Why this note exists:
- Transparency about the project's conceptual origin points.
- Ensures users understand the operational rigor requirements are grounded in real-world critical-system thinking, not arbitrary.
- Makes clear that BeastMode is a published, open-source tool not dependent on any military or defense partnerships.
| Version | Stability | Coverage | Known Limitations |
|---|---|---|---|
| 3.1 profile set | Stable | Profile files and standards docs | No executable test suite in this repo |
pie title Repository Content Composition
"Agent Profiles" : 65
"Documentation" : 30
"GitHub Community Files" : 5
Note
This repository is configuration-first. Validation is performed through file integrity checks and settings discovery checks rather than unit tests.
gantt
title BeastMode Documentation and Standards Roadmap
dateFormat YYYY-MM-DD
section Foundation
Baseline profiles and compatibility :done, p1, 2026-04-01, 2026-04-20
GitHub standards files :done, p2, 2026-05-05, 2026-05-05
section Next
Add automated markdown lint workflow :active, p3, 2026-05-06, 2026-05-20
Add profile consistency check script :p4, 2026-05-20, 2026-06-10
| Phase | Goals | Target | Status |
|---|---|---|---|
| Foundation | Consolidate profile files and baseline docs | Completed | ✅ |
| Standards | Add GitHub community and repository hygiene files | Completed | ✅ |
| Quality Automation | Add markdown lint and consistency checks | Planned | 🟡 |
Use the standard GitHub flow:
- Fork repository.
- Create branch (
feature/...,fix/...,docs/...). - Make focused changes.
- Open pull request with validation notes.
See full guidance in CONTRIBUTING.md.
Contribution quality checklist
- Keep behavior rules internally consistent.
- Update README when workflow behavior changes.
- Keep
.agent.md,.md, and legacy variants aligned where required. - Avoid introducing contradictory tool requirements.
Security reporting guidance is in SECURITY.md.
Caution
Do not publish sensitive details for potential vulnerabilities in public issues.
Distributed under the MIT License. See LICENSE.
- VS Code Copilot customization documentation
- Internal prompt engineering workflows from the claude-prompts repository