Skip to content

AGENTS.md

Latest commit

 

History

History
29 lines (20 loc) · 989 Bytes

AGENTS.md

File metadata and controls

29 lines (20 loc) · 989 Bytes
Raw

AGENTS.md

Instructions for Cortex Code when working in this repository.

Project overview

This is a GitHub Actions composite action written in TypeScript using Bun. It provides AI-powered PR code reviews for data teams using the Cortex Code Agent SDK.

Key files

  • action.yml -- The public interface (inputs, outputs, steps)
  • src/security/can-use-tool.ts -- Security gate (most critical file -- review changes carefully)
  • src/entrypoints/run-cortex.ts -- Main entry point
  • docs/ -- User-facing documentation

Development rules

  • Run bun run typecheck after any TypeScript changes
  • Run bun test to validate security gate behavior
  • The canUseTool gate is security-critical: any change to blocked-tools.ts or blocked-paths.ts requires a corresponding test in test/security/
  • Never add allowDangerouslySkipPermissions: true or permissionMode: "bypassPermissions" anywhere in the codebase

Testing

bun install
bun run typecheck
bun test