القائمة
Documentation standards for sfdx-hardis commands (description format with Command Behavior and Technical explanations sections, MkDocs site, build:doc). Use when creating or modifying commands.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
How to pick the correct uxLog level (action, log, warning, error, success, other), the matching chalk color, the options object (sensitive, alwaysVisible), VS Code UI suppression, and uxLogTable. Use when adding or modifying any uxLog call.
Style rules for updating CHANGELOG.md entries. Use whenever the user asks to update, add to, or write entries in CHANGELOG.md.
Gather requirements by asking clarifying questions until the problem is fully understood. First step of the contribution workflow.
Design the solution and write a technical specification based on requirements analysis. Second step of the contribution workflow, use after /analyze.
Handle CVE/vulnerability reports from security linters (trivy, osv-scanner, etc.). Tries to upgrade first; ignores only when safe and justified.
Implement a feature, bug fix, or code change in sfdx-hardis. Use whenever the user asks to add a feature, fix a bug, implement something, or make a code change - with or without a prior /design phase.
| name | documentation |
| description | Documentation standards for sfdx-hardis commands (description format with Command Behavior and Technical explanations sections, MkDocs site, build:doc). Use when creating or modifying commands. |
| user-invocable | false |
Every command must have a static description with ## Command Behavior and <details> sections:
public static description = `
## Command Behavior
**Brief description of what this command does.**
Key functionalities:
- **Feature 1:** Description
- **Feature 2:** Description
This command is part of [sfdx-hardis Feature](${CONSTANTS.DOC_URL_ROOT}/path/).
### Agent Mode
Supports non-interactive execution with \`--agent\`:
\`\`\`sh
sf hardis:<topic>:<action> --agent --target-org myorg@example.com
\`\`\`
In agent mode, all interactive prompts are skipped and default values are applied.
<details markdown="1">
<summary>Technical explanations</summary>
Technical implementation details...
</details>
`;
When a command exposes an --agent flag, its description must include a ### Agent Mode section explaining:
--agent with all required flags.--task-name, --target-branch) vs. which are optional.daily period", "skips metadata pull").The examples array must also include at least one entry that uses --agent.
--target-org)
### Agent Mode
Supports non-interactive execution with \`--agent\`:
\`\`\`sh
sf hardis:org:diagnose:mycommand --agent --target-org myorg@example.com
\`\`\`
In agent mode, all interactive prompts are skipped and default values are used.
### Agent Mode
Supports non-interactive execution with \`--agent\`:
\`\`\`sh
sf hardis:org:diagnose:unusedusers --agent --days 180 --licensetypes all-crm --target-org myorg@example.com
\`\`\`
In agent mode:
- \`--days\` defaults to 180 when not provided.
- \`--licensetypes\` defaults to \`all-crm\` when not provided.
- Interactive deletion prompts are skipped.
Supports non-interactive execution with \--agent` (uses default values and skips prompts).- replace it with a proper### Agent Mode` section.yarn build:docThe file docs/salesforce-agentic-automation.md contains a reference table of all sfdx-hardis commands that support --agent. This table is the canonical discovery page for AI agents and users who want to know what automation is possible.
When you add --agent support to a command, you must also:
Add the command to the appropriate category table in docs/salesforce-agentic-automation.md.
Use this table row format:
| [**hardis:topic:action**](hardis/topic/action.md) | One-sentence description of what an agent can do with this command - include key flags if any |
Place the row in the correct category section (Development Workflow, Org Diagnostics, Monitoring, etc.). Add a new category section if none of the existing ones fit.
When you remove --agent support from a command, remove its row from the table.
The page is registered in mkdocs.yml under AI & Agents > AI Agents Overview. No mkdocs.yml change is needed when adding individual command rows - only the markdown table in docs/salesforce-agentic-automation.md needs updating.