Get started with LightSpeedWP agents in three steps:

1. Clone the repository

   git clone https://github.com/lightspeedwp/.github.git
   cd .github

2. Install dependencies

   • For Node.js/JS agents: npm install
   • For Python agents: pip install -r requirements.txt (if present)
   • For shell agents: Ensure required tools (bash, zsh, etc.) are installed

3. Run or use an agent

   • See the agent spec table below for usage instructions per agent type
   • Example (Node.js): node agents/template.agent.js
   • Example (Python): python agents/template.agent.py
   • Example (Shell): bash agents/template.agent.sh

For advanced usage, see the Main Agent Index and individual agent specs for configuration, integration, and automation options.

This directory contains all GitHub automation agents that power LightSpeed's repository workflows, including their implementations, documentation, and comprehensive test suites.

graph TB
    A[GitHub Events] --> B[GitHub Actions Workflows]
    B --> C[Agent Orchestration]
    C --> D[Core Agents]
    C --> E[WordPress Agents]
    C --> F[Specialized Agents]

    D --> D1[labeling.agent.js]
    D --> D2[reviewer.agent.js]
    D --> D3[issue-type.agent.js]
    D --> D4[badges.agent.js]
    D --> D5[manage-readmes.agent.js]
    D --> D6[header-footer.agent.js]
    D --> D7[linting.agent.js]
    D --> D8[label-standardization.agent.js]
    D --> D9[meta.agent.js]

    E --> E1[wp-accessibility-review-agent.js]
    E --> E2[wp-performance-audit-agent.js]
    E --> E3[wp-security-review-agent.js]

    F --> F1[jsdoc-review.agent.md]

    G[Repository Changes] --> H[Automated Responses]
    H --> I[Issue Labeling]
    H --> J[Code Review]
    H --> K[Badge Updates]
    H --> L[README Maintenance]
    H --> M[Documentation Updates]

    D1 --> I
    D2 --> J
    D4 --> K
    D5 --> L
    D6 --> M

    N[Test Suite] --> D
    N --> E
    O[Agent Documentation] --> D
    O --> E
    O --> F

    style A fill:#e1f5fe
    style C fill:#f3e5f5
    style N fill:#e8f5e8
    style H fill:#fff3e0

These GitHub Actions workflows integrate with and trigger our agents:

The __tests__/ directory contains comprehensive test suites for our agents:

Tests are automatically executed via the jest-test-audit.yml workflow on push and pull request events.

Agent-related prompts available in the ../prompts/ directory:

Agent development instructions in the ../instructions/ directory:

Agent-related chat modes available in the ../chatmodes/awesome-copilot/ directory:

graph TD
    A[GitHub Event] --> B{Workflow Trigger}
    B --> C[GitHub Actions Workflow]
    C --> D[Agent Execution]
    D --> E[Agent Logic]
    E --> F[GitHub API Calls]
    F --> G[Repository Updates]
    G --> H[Completion Logging]

• Node.js 20+: All JavaScript agents
• GitHub API: Repository interaction
• YAML Configs: Label and issue type definitions
• Test Framework: Jest for automated testing

1. Use the build-agent-and-tests.prompt.md prompt
2. Follow the ai-agents.instructions.md guidelines
3. Reference existing agents for patterns and structure
4. Include comprehensive test coverage
5. Document the agent in both .js and .md formats

• Security: Never expose secrets or tokens
• Reliability: Include error handling and logging
• Testing: Comprehensive test suites required
• Documentation: Both technical specs and user guides
• Integration: Proper workflow integration

Note: This directory is actively maintained and automatically updated by our automation systems. For questions or issues, reference the agent.md index or open an issue with the ai-ops:agents label.