ailabs/puaros
1
0
Fork 0
mirror of https://github.com/samiyev/puaros.git synced 2025-12-27 23:06:54 +05:00
Code Issues Packages Projects Releases Wiki Activity

feat(cli): add AI Agent Instructions to --help output

Browse Source 
Add dedicated section in help for AI coding assistants with:
- Step-by-step workflow (scan → fix → verify → expand)
- Recommended commands for each step
- Output format description for parsing
- Priority order guidance (CRITICAL → HIGH → MEDIUM → LOW)

This helps AI agents (Claude, Copilot, Cursor) immediately
understand how to use Guardian and take action.
This commit is contained in:
imfozilbek
2025-11-25 15:48:03 +05:00
parent 24f54d4b57
commit 8916ce9eab
2 changed files with 40 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
packages/guardian/src/cli/constants.ts
View File

@@ -150,4 +150,30 @@ export const CLI_HELP_TEXT = {
FIX_REPOSITORY:
" Repository pattern → Create IUserRepository in domain, implement in infra\n\n",
FOOTER: "Each violation includes a 💡 Suggestion with specific fix instructions.\n",
AI_AGENT_HEADER: "AI AGENT INSTRUCTIONS:\n",
AI_AGENT_INTRO:
" When an AI coding assistant (Claude, Copilot, Cursor, etc.) uses Guardian:\n\n",
AI_AGENT_STEP1: " STEP 1: Run initial scan\n",
AI_AGENT_STEP1_CMD: " $ guardian check ./src --only-critical --limit 5\n\n",
AI_AGENT_STEP2: " STEP 2: For each violation in output:\n",
AI_AGENT_STEP2_DETAIL:
" - Read the file at reported location (file:line:column)\n" +
" - Apply the 💡 Suggestion provided\n" +
" - The suggestion contains exact fix instructions\n\n",
AI_AGENT_STEP3: " STEP 3: After fixing, verify:\n",
AI_AGENT_STEP3_CMD: " $ guardian check ./src --only-critical\n\n",
AI_AGENT_STEP4: " STEP 4: Expand scope progressively:\n",
AI_AGENT_STEP4_CMDS:
" $ guardian check ./src --min-severity high # Fix HIGH issues\n" +
" $ guardian check ./src --min-severity medium # Fix MEDIUM issues\n" +
" $ guardian check ./src # Full scan\n\n",
AI_AGENT_OUTPUT: " OUTPUT FORMAT (parse this):\n",
AI_AGENT_OUTPUT_DETAIL:
" <index>. <file>:<line>:<column>\n" +
" Severity: <emoji> <LEVEL>\n" +
" Type: <violation-type>\n" +
" Value: <problematic-value>\n" +
" Context: <code-snippet>\n" +
" 💡 Suggestion: <exact-fix-instruction>\n\n",
AI_AGENT_PRIORITY: " PRIORITY ORDER: CRITICAL → HIGH → MEDIUM → LOW\n\n",
} as const

15
packages/guardian/src/cli/index.ts
View File

@@ -122,7 +122,20 @@ program
CLI_HELP_TEXT.FIX_ENTITY +
CLI_HELP_TEXT.FIX_DEPENDENCY +
CLI_HELP_TEXT.FIX_REPOSITORY +
CLI_HELP_TEXT.FOOTER,
CLI_HELP_TEXT.FOOTER +
CLI_HELP_TEXT.AI_AGENT_HEADER +
CLI_HELP_TEXT.AI_AGENT_INTRO +
CLI_HELP_TEXT.AI_AGENT_STEP1 +
CLI_HELP_TEXT.AI_AGENT_STEP1_CMD +
CLI_HELP_TEXT.AI_AGENT_STEP2 +
CLI_HELP_TEXT.AI_AGENT_STEP2_DETAIL +
CLI_HELP_TEXT.AI_AGENT_STEP3 +
CLI_HELP_TEXT.AI_AGENT_STEP3_CMD +
CLI_HELP_TEXT.AI_AGENT_STEP4 +
CLI_HELP_TEXT.AI_AGENT_STEP4_CMDS +
CLI_HELP_TEXT.AI_AGENT_OUTPUT +
CLI_HELP_TEXT.AI_AGENT_OUTPUT_DETAIL +
CLI_HELP_TEXT.AI_AGENT_PRIORITY,
)
program