diff --git a/.github/instructions.md b/.github/instructions.md new file mode 100644 index 000000000..4c358efe1 --- /dev/null +++ b/.github/instructions.md @@ -0,0 +1,1478 @@ +# SRECTL - SRE Agent CLI Instructions + +This file contains comprehensive documentation for all SRECTL commands and their usage. +Generated on: 2026-04-28 14:17:19 UTC + +## Table of Contents + +1. [Main Command](#main-command) +2. [General Commands](#general-commands) + - [init](#init-command) + - [list](#list-command) + - [apply-yaml](#apply-yaml-command) +3. [Agent Commands](#agent-commands) + - [agent create](#agent-create-command) + - [agent validate](#agent-validate-command) + - [agent apply](#agent-apply-command) + - [agent run](#agent-run-command) +4. [Tool Commands](#tool-commands) + - [tool create](#tool-create-command) + - [tool validate](#tool-validate-command) + - [tool apply](#tool-apply-command) + - [tool show-types](#tool-show-types-command) + - [tool show-connectors](#tool-show-connectors-command) +5. [Skills Commands](#skills-commands) + - [skill create](#skill-create-command) + - [skill upload](#skill-upload-command) + - [skill list](#skill-list-command) + - [skill delete](#skill-delete-command) + - [skill convert](#skill-convert-command) + - [skill download](#skill-download-command) + +## Main Command + +### Main Command {#main-command} + +``` +$ srectl --help + +Description: + SRE Agent CLI - Your intelligent assistant for managing SRE agents and automating incident response + +Usage: + srectl [options] + srectl [options] + +Options: + -h, /h, -?, /? Show help and usage information + --version Show version information + --debug Enable debug logging + --quiet Minimize output + +Subgroups: + agent Agent commands for managing SRE automation agents + tool Tool commands for managing SRE automation tools + common-prompt Common prompt commands for managing shared prompts + extension Extension commands for generating deployment files and configurations + mcp Model Context Protocol server for building SRE agents + doc Document management commands. Upload and manage documents like TSGs, architecture docs, runbooks, and other reference materials for agents to use + workspace Workspace management commands. Upload, download, and delete workspace files. + incident-filter Incident filter commands for managing incident routing rules + hook Manage hooks for agent safety and governance + thread Thread management commands + profile Profile management commands. Profiles store connection settings for different SRE Agent instances (local or remote) + repo Manage Azure DevOps repository connectors for TSG documents + skill Skill management commands. Apply and manage custom skills for agents to use, or convert an existing agent into a skill. + incidenthandler Manage incident response plans and filters + scheduledtask Manage scheduled tasks for automated agent operations + release-trigger Release trigger commands for managing pipeline event response plans + +Commands: + welcome Show welcome screen and getting started guide + version Show version information and build details + init Initialize SREAgent CLI configuration and workspace + + Examples: + # Initialize with local development server + srectl init --resource-url https://localhost:7023 + + # Initialize with remote server + srectl init --resource-url https://my-sreagent-dev.1abcdef.eastus2.azuresre.ai + + # Initialize with production environment + srectl init --resource-url https://my-sreagent-prod.2abcdef.eastus2.azuresre.ai + status Show workspace status and health check + apply-yaml, apply Apply YAML configuration files to the server + Supports multi-document YAML files (separated by ---) similar to Kubernetes manifests. + Automatically detects and applies tools, agents, and common prompts. + + Examples: + # Apply a single resource YAML file + srectl apply-yaml --file agents/MyAgent/MyAgent.yaml + + # Apply a multi-document YAML file + srectl apply-yaml --file manifests/all-resources.yaml + + # Apply a tool YAML file + srectl apply-yaml --file tools/KustoTool.yaml + + # Apply a common prompt YAML file + srectl apply-yaml --file CommonPrompts/prompt.yaml + interactive Start interactive guided mode for step-by-step assistance + sync Sync agents and tools YAML from the remote server into the local workspace (agents/, tools/) + + Examples: + # Sync all remote configurations + srectl sync + + Note: Requires prior 'srectl init --resource-url ' + chat Start an interactive chat session with the SRE Agent + + Examples: + # Start interactive chat + srectl chat + + # Start chat with debug logging + srectl chat --debug + + # Start chat with minimal output + srectl chat --quiet +``` + +## General Commands + +### init Command {#init-command} + +``` +$ srectl init --help + +Description: + Initialize SREAgent CLI configuration and workspace + + Examples: + # Initialize with local development server + srectl init --resource-url https://localhost:7023 + + # Initialize with remote server + srectl init --resource-url https://my-sreagent-dev.1abcdef.eastus2.azuresre.ai + + # Initialize with production environment + srectl init --resource-url https://my-sreagent-prod.2abcdef.eastus2.azuresre.ai + +Usage: + srectl init [options] + +Options: + --resource-url (REQUIRED) Base URL of the SRE Agent server + -?, -h, --help Show help and usage information + --debug Enable debug logging + --quiet Minimize output +``` + +### list Command {#list-command} + +``` +$ srectl list --help + +Description: + SRE Agent CLI - Your intelligent assistant for managing SRE agents and automating incident response + +Usage: + srectl [options] + srectl [options] + +Options: + -h, /h, -?, /? Show help and usage information + --version Show version information + --debug Enable debug logging + --quiet Minimize output + +Subgroups: + agent Agent commands for managing SRE automation agents + tool Tool commands for managing SRE automation tools + common-prompt Common prompt commands for managing shared prompts + extension Extension commands for generating deployment files and configurations + mcp Model Context Protocol server for building SRE agents + doc Document management commands. Upload and manage documents like TSGs, architecture docs, runbooks, and other reference materials for agents to use + workspace Workspace management commands. Upload, download, and delete workspace files. + incident-filter Incident filter commands for managing incident routing rules + hook Manage hooks for agent safety and governance + thread Thread management commands + profile Profile management commands. Profiles store connection settings for different SRE Agent instances (local or remote) + repo Manage Azure DevOps repository connectors for TSG documents + skill Skill management commands. Apply and manage custom skills for agents to use, or convert an existing agent into a skill. + incidenthandler Manage incident response plans and filters + scheduledtask Manage scheduled tasks for automated agent operations + release-trigger Release trigger commands for managing pipeline event response plans + +Commands: + welcome Show welcome screen and getting started guide + version Show version information and build details + init Initialize SREAgent CLI configuration and workspace + + Examples: + # Initialize with local development server + srectl init --resource-url https://localhost:7023 + + # Initialize with remote server + srectl init --resource-url https://my-sreagent-dev.1abcdef.eastus2.azuresre.ai + + # Initialize with production environment + srectl init --resource-url https://my-sreagent-prod.2abcdef.eastus2.azuresre.ai + status Show workspace status and health check + apply-yaml, apply Apply YAML configuration files to the server + Supports multi-document YAML files (separated by ---) similar to Kubernetes manifests. + Automatically detects and applies tools, agents, and common prompts. + + Examples: + # Apply a single resource YAML file + srectl apply-yaml --file agents/MyAgent/MyAgent.yaml + + # Apply a multi-document YAML file + srectl apply-yaml --file manifests/all-resources.yaml + + # Apply a tool YAML file + srectl apply-yaml --file tools/KustoTool.yaml + + # Apply a common prompt YAML file + srectl apply-yaml --file CommonPrompts/prompt.yaml + interactive Start interactive guided mode for step-by-step assistance + sync Sync agents and tools YAML from the remote server into the local workspace (agents/, tools/) + + Examples: + # Sync all remote configurations + srectl sync + + Note: Requires prior 'srectl init --resource-url ' + chat Start an interactive chat session with the SRE Agent + + Examples: + # Start interactive chat + srectl chat + + # Start chat with debug logging + srectl chat --debug + + # Start chat with minimal output + srectl chat --quiet +``` + +### list agents Command {#list-agents-command} + +``` +$ srectl list agents --help + +Description: + SRE Agent CLI - Your intelligent assistant for managing SRE agents and automating incident response + +Usage: + srectl [options] + srectl [options] + +Options: + -h, /h, -?, /? Show help and usage information + --version Show version information + --debug Enable debug logging + --quiet Minimize output + +Subgroups: + agent Agent commands for managing SRE automation agents + tool Tool commands for managing SRE automation tools + common-prompt Common prompt commands for managing shared prompts + extension Extension commands for generating deployment files and configurations + mcp Model Context Protocol server for building SRE agents + doc Document management commands. Upload and manage documents like TSGs, architecture docs, runbooks, and other reference materials for agents to use + workspace Workspace management commands. Upload, download, and delete workspace files. + incident-filter Incident filter commands for managing incident routing rules + hook Manage hooks for agent safety and governance + thread Thread management commands + profile Profile management commands. Profiles store connection settings for different SRE Agent instances (local or remote) + repo Manage Azure DevOps repository connectors for TSG documents + skill Skill management commands. Apply and manage custom skills for agents to use, or convert an existing agent into a skill. + incidenthandler Manage incident response plans and filters + scheduledtask Manage scheduled tasks for automated agent operations + release-trigger Release trigger commands for managing pipeline event response plans + +Commands: + welcome Show welcome screen and getting started guide + version Show version information and build details + init Initialize SREAgent CLI configuration and workspace + + Examples: + # Initialize with local development server + srectl init --resource-url https://localhost:7023 + + # Initialize with remote server + srectl init --resource-url https://my-sreagent-dev.1abcdef.eastus2.azuresre.ai + + # Initialize with production environment + srectl init --resource-url https://my-sreagent-prod.2abcdef.eastus2.azuresre.ai + status Show workspace status and health check + apply-yaml, apply Apply YAML configuration files to the server + Supports multi-document YAML files (separated by ---) similar to Kubernetes manifests. + Automatically detects and applies tools, agents, and common prompts. + + Examples: + # Apply a single resource YAML file + srectl apply-yaml --file agents/MyAgent/MyAgent.yaml + + # Apply a multi-document YAML file + srectl apply-yaml --file manifests/all-resources.yaml + + # Apply a tool YAML file + srectl apply-yaml --file tools/KustoTool.yaml + + # Apply a common prompt YAML file + srectl apply-yaml --file CommonPrompts/prompt.yaml + interactive Start interactive guided mode for step-by-step assistance + sync Sync agents and tools YAML from the remote server into the local workspace (agents/, tools/) + + Examples: + # Sync all remote configurations + srectl sync + + Note: Requires prior 'srectl init --resource-url ' + chat Start an interactive chat session with the SRE Agent + + Examples: + # Start interactive chat + srectl chat + + # Start chat with debug logging + srectl chat --debug + + # Start chat with minimal output + srectl chat --quiet +``` + +### list tools Command {#list-tools-command} + +``` +$ srectl list tools --help + +Description: + SRE Agent CLI - Your intelligent assistant for managing SRE agents and automating incident response + +Usage: + srectl [options] + srectl [options] + +Options: + -h, /h, -?, /? Show help and usage information + --version Show version information + --debug Enable debug logging + --quiet Minimize output + +Subgroups: + agent Agent commands for managing SRE automation agents + tool Tool commands for managing SRE automation tools + common-prompt Common prompt commands for managing shared prompts + extension Extension commands for generating deployment files and configurations + mcp Model Context Protocol server for building SRE agents + doc Document management commands. Upload and manage documents like TSGs, architecture docs, runbooks, and other reference materials for agents to use + workspace Workspace management commands. Upload, download, and delete workspace files. + incident-filter Incident filter commands for managing incident routing rules + hook Manage hooks for agent safety and governance + thread Thread management commands + profile Profile management commands. Profiles store connection settings for different SRE Agent instances (local or remote) + repo Manage Azure DevOps repository connectors for TSG documents + skill Skill management commands. Apply and manage custom skills for agents to use, or convert an existing agent into a skill. + incidenthandler Manage incident response plans and filters + scheduledtask Manage scheduled tasks for automated agent operations + release-trigger Release trigger commands for managing pipeline event response plans + +Commands: + welcome Show welcome screen and getting started guide + version Show version information and build details + init Initialize SREAgent CLI configuration and workspace + + Examples: + # Initialize with local development server + srectl init --resource-url https://localhost:7023 + + # Initialize with remote server + srectl init --resource-url https://my-sreagent-dev.1abcdef.eastus2.azuresre.ai + + # Initialize with production environment + srectl init --resource-url https://my-sreagent-prod.2abcdef.eastus2.azuresre.ai + status Show workspace status and health check + apply-yaml, apply Apply YAML configuration files to the server + Supports multi-document YAML files (separated by ---) similar to Kubernetes manifests. + Automatically detects and applies tools, agents, and common prompts. + + Examples: + # Apply a single resource YAML file + srectl apply-yaml --file agents/MyAgent/MyAgent.yaml + + # Apply a multi-document YAML file + srectl apply-yaml --file manifests/all-resources.yaml + + # Apply a tool YAML file + srectl apply-yaml --file tools/KustoTool.yaml + + # Apply a common prompt YAML file + srectl apply-yaml --file CommonPrompts/prompt.yaml + interactive Start interactive guided mode for step-by-step assistance + sync Sync agents and tools YAML from the remote server into the local workspace (agents/, tools/) + + Examples: + # Sync all remote configurations + srectl sync + + Note: Requires prior 'srectl init --resource-url ' + chat Start an interactive chat session with the SRE Agent + + Examples: + # Start interactive chat + srectl chat + + # Start chat with debug logging + srectl chat --debug + + # Start chat with minimal output + srectl chat --quiet +``` + +### apply-yaml Command {#apply-yaml-command} + +``` +$ srectl apply-yaml --help + +Description: + Apply YAML configuration files to the server + Supports multi-document YAML files (separated by ---) similar to Kubernetes manifests. + Automatically detects and applies tools, agents, and common prompts. + + Examples: + # Apply a single resource YAML file + srectl apply-yaml --file agents/MyAgent/MyAgent.yaml + + # Apply a multi-document YAML file + srectl apply-yaml --file manifests/all-resources.yaml + + # Apply a tool YAML file + srectl apply-yaml --file tools/KustoTool.yaml + + # Apply a common prompt YAML file + srectl apply-yaml --file CommonPrompts/prompt.yaml + +Usage: + srectl apply-yaml [options] + +Options: + -f, --file (REQUIRED) Path to the YAML file to apply + -?, -h, --help Show help and usage information + --debug Enable debug logging + --quiet Minimize output +``` + +## Agent Commands + +### agent Command {#agent-command} + +``` +$ srectl agent --help + +Description: + Agent commands for managing SRE automation agents + +Usage: + srectl agent [command] [options] + +Options: + -?, -h, --help Show help and usage information + --debug Enable debug logging + --quiet Minimize output + +Commands: + create Create a new agent YAML configuration file + + Examples: + # Create a basic agent + srectl agent create --name DevOpsAgent --instructions "Help with DevOps tasks such as monitoring and incident response" + + # Create an agent with tools + srectl agent create --name KustoAgent --tools QueryKusto AnalyzeMetrics + + # Create an agent with AI assistance (smart mode) + srectl agent create --name StorageAgent --smart --instructions "Help troubleshoot Azure Storage issues" + + # Create an advanced agent with all options + srectl agent create --name AdvancedAgent \ + --instructions "Complex multi-step agent" \ + --tools Tool1 Tool2 \ + --handoffs Agent1 Agent2 \ + --temperature 0.7 \ + --max-reflection-count 3 + validate Validate agent YAML configuration files + + Examples: + # Validate by agent name (searches in agents/ folder) + srectl agent validate --name MyAgent + + # Validate specific agent by name and check tools + srectl agent validate --name KustoAgent --check-tools + + # Validate all agent files + srectl agent validate --all + + # Validate with tool availability checking + srectl agent validate --all --check-tools + + # Alternative: Validate a specific agent file path + srectl agent validate --file agents/MyAgent/MyAgent.yaml + apply Apply an agent configuration to the remote server + + Examples: + # Apply an agent to the server + srectl agent apply --name DevOpsAgent + + # Preview what would be applied (dry run) + srectl agent apply --name KustoAgent --dry-run + + # Apply with debug logging + srectl agent apply --name MyAgent --debug + delete Delete an agent from the remote server + + Examples: + # Delete an agent from the server + srectl agent delete --name OldAgent + + # Delete with debug logging + srectl agent delete --name TestAgent --debug + test Test an agent with a specific message (starts interactive session) + + Examples: + # Test an agent interactively + srectl agent test --name DevOpsAgent --message "Check pod status in namespace production" + + # Send test message without waiting for response + srectl agent test --name KustoAgent --message "Query memory usage" --no-wait + + # Start interactive session with specific agent + srectl agent test --name MyAgent --message "Help me debug this issue" + + Note: This command is equivalent to 'srectl thread new --agent --message ' + and will start an interactive chat session unless --no-wait is specified. + diff Compare local and remote agent configurations + + Examples: + # Compare default using git-diff (default) + srectl agent diff --name DevOpsAgent + + # Use VS Code diff + srectl agent diff --name KustoAgent --tool code + + # Show inline diff + srectl agent diff --name MyAgent --raw + migrate Migrate V1 agent format to V2 + + Examples: + # Migrate a specific agent + srectl agent migrate --name MyAgent + + # Migrate all agents + srectl agent migrate --all + + # Preview migration changes (dry run) + srectl agent migrate --all --dry-run + + # Migrate specific agent with dry run + srectl agent migrate --name MyAgent --dry-run + list List remote extended agents from the server + + Examples: + # List all agents + srectl agent list + + # List all agents with full YAML details + srectl agent list --detail + + # Get a specific agent by name (full YAML output) + srectl agent list --name MyAgent + + # Search for specific agents + srectl agent list --search devops +``` + +### agent create Command {#agent-create-command} + +``` +$ srectl agent create --help + +Description: + Create a new agent YAML configuration file + + Examples: + # Create a basic agent + srectl agent create --name DevOpsAgent --instructions "Help with DevOps tasks such as monitoring and incident response" + + # Create an agent with tools + srectl agent create --name KustoAgent --tools QueryKusto AnalyzeMetrics + + # Create an agent with AI assistance (smart mode) + srectl agent create --name StorageAgent --smart --instructions "Help troubleshoot Azure Storage issues" + + # Create an advanced agent with all options + srectl agent create --name AdvancedAgent \ + --instructions "Complex multi-step agent" \ + --tools Tool1 Tool2 \ + --handoffs Agent1 Agent2 \ + --temperature 0.7 \ + --max-reflection-count 3 + +Usage: + srectl agent create [options] + +Options: + --name (REQUIRED) Name of the agent + --instructions Instructions for the agent + --tools Tools the agent can use + --mcp-tools MCP tools the agent can use + --handoff-description Description for handoff capabilities + --handoffs Agents this agent can hand off to + --allow-parallel-tool-calls Allow parallel tool execution + --max-reflection-count Maximum number of reflection iterations + --critic-prompt-path Path to critic prompt file + --critic-on-handoff Enable critic on handoff + --custom-reflection-note Custom note for reflection + --common-prompts Common prompts to include + --temperature Model temperature setting + --output-type Expected output format + --vanilla-mode Use vanilla mode without enhancements + --smart Use AI to generate instructions and recommend tools + --enable-skills Enable skills for the agent + --add-system-skills Add system skills (not recommended for custom meta-agents) + -?, -h, --help Show help and usage information + --debug Enable debug logging + --quiet Minimize output +``` + +### agent validate Command {#agent-validate-command} + +``` +$ srectl agent validate --help + +Description: + Validate agent YAML configuration files + + Examples: + # Validate by agent name (searches in agents/ folder) + srectl agent validate --name MyAgent + + # Validate specific agent by name and check tools + srectl agent validate --name KustoAgent --check-tools + + # Validate all agent files + srectl agent validate --all + + # Validate with tool availability checking + srectl agent validate --all --check-tools + + # Alternative: Validate a specific agent file path + srectl agent validate --file agents/MyAgent/MyAgent.yaml + +Usage: + srectl agent validate [options] + +Options: + --name Agent name to validate + --file YAML file to validate + --all Validate all agents + --check-tools Validate that referenced tools exist + -?, -h, --help Show help and usage information + --debug Enable debug logging + --quiet Minimize output +``` + +### agent apply Command {#agent-apply-command} + +``` +$ srectl agent apply --help + +Description: + Apply an agent configuration to the remote server + + Examples: + # Apply an agent to the server + srectl agent apply --name DevOpsAgent + + # Preview what would be applied (dry run) + srectl agent apply --name KustoAgent --dry-run + + # Apply with debug logging + srectl agent apply --name MyAgent --debug + +Usage: + srectl agent apply [options] + +Options: + --name (REQUIRED) Name of the agent to apply + --dry-run Preview changes without applying + -?, -h, --help Show help and usage information + --debug Enable debug logging + --quiet Minimize output +``` + +### agent run Command {#agent-run-command} + +``` +$ srectl agent run --help + +Description: + Agent commands for managing SRE automation agents + +Usage: + srectl agent [command] [options] + +Options: + -?, -h, --help Show help and usage information + --debug Enable debug logging + --quiet Minimize output + +Commands: + create Create a new agent YAML configuration file + + Examples: + # Create a basic agent + srectl agent create --name DevOpsAgent --instructions "Help with DevOps tasks such as monitoring and incident response" + + # Create an agent with tools + srectl agent create --name KustoAgent --tools QueryKusto AnalyzeMetrics + + # Create an agent with AI assistance (smart mode) + srectl agent create --name StorageAgent --smart --instructions "Help troubleshoot Azure Storage issues" + + # Create an advanced agent with all options + srectl agent create --name AdvancedAgent \ + --instructions "Complex multi-step agent" \ + --tools Tool1 Tool2 \ + --handoffs Agent1 Agent2 \ + --temperature 0.7 \ + --max-reflection-count 3 + validate Validate agent YAML configuration files + + Examples: + # Validate by agent name (searches in agents/ folder) + srectl agent validate --name MyAgent + + # Validate specific agent by name and check tools + srectl agent validate --name KustoAgent --check-tools + + # Validate all agent files + srectl agent validate --all + + # Validate with tool availability checking + srectl agent validate --all --check-tools + + # Alternative: Validate a specific agent file path + srectl agent validate --file agents/MyAgent/MyAgent.yaml + apply Apply an agent configuration to the remote server + + Examples: + # Apply an agent to the server + srectl agent apply --name DevOpsAgent + + # Preview what would be applied (dry run) + srectl agent apply --name KustoAgent --dry-run + + # Apply with debug logging + srectl agent apply --name MyAgent --debug + delete Delete an agent from the remote server + + Examples: + # Delete an agent from the server + srectl agent delete --name OldAgent + + # Delete with debug logging + srectl agent delete --name TestAgent --debug + test Test an agent with a specific message (starts interactive session) + + Examples: + # Test an agent interactively + srectl agent test --name DevOpsAgent --message "Check pod status in namespace production" + + # Send test message without waiting for response + srectl agent test --name KustoAgent --message "Query memory usage" --no-wait + + # Start interactive session with specific agent + srectl agent test --name MyAgent --message "Help me debug this issue" + + Note: This command is equivalent to 'srectl thread new --agent --message ' + and will start an interactive chat session unless --no-wait is specified. + diff Compare local and remote agent configurations + + Examples: + # Compare default using git-diff (default) + srectl agent diff --name DevOpsAgent + + # Use VS Code diff + srectl agent diff --name KustoAgent --tool code + + # Show inline diff + srectl agent diff --name MyAgent --raw + migrate Migrate V1 agent format to V2 + + Examples: + # Migrate a specific agent + srectl agent migrate --name MyAgent + + # Migrate all agents + srectl agent migrate --all + + # Preview migration changes (dry run) + srectl agent migrate --all --dry-run + + # Migrate specific agent with dry run + srectl agent migrate --name MyAgent --dry-run + list List remote extended agents from the server + + Examples: + # List all agents + srectl agent list + + # List all agents with full YAML details + srectl agent list --detail + + # Get a specific agent by name (full YAML output) + srectl agent list --name MyAgent + + # Search for specific agents + srectl agent list --search devops +``` + +## Tool Commands + +### tool Command {#tool-command} + +``` +$ srectl tool --help + +Description: + Tool commands for managing SRE automation tools + +Usage: + srectl tool [command] [options] + +Options: + -?, -h, --help Show help and usage information + --debug Enable debug logging + --quiet Minimize output + +Commands: + create Create a new tool YAML configuration file + validate Validate tool YAML configuration files + + Examples: + # Validate a specific tool + srectl tool validate --name QueryMetrics + + # Validate all tools + srectl tool validate --all + + # Validate with debug output + srectl tool validate --name MyTool --debug + apply Apply a tool configuration to the remote server + + Examples: + # Apply a tool to the server + srectl tool apply --name QueryMetrics + + # Preview what would be applied (dry run) + srectl tool apply --name StorageOps --dry-run + + # Apply with debug logging + srectl tool apply --name CustomTool --debug + delete Delete a tool from the remote server + + Examples: + # Delete a tool from the server + srectl tool delete --name OldTool + + # Preview what would be deleted (dry run) + srectl tool delete --name TestTool --dry-run + + # Delete with debug logging + srectl tool delete --name UnusedTool --debug + diff Compare local and remote tool configurations + + Examples: + # Compare default using git + srectl tool diff --name QueryMetrics + + # Use VS Code diff + srectl tool diff --name MyTool --tool code + + # Show inline diff + srectl tool diff --name MyTool --raw + migrate Migrate V1 tool configurations to V2 format + + Examples: + # Migrate a specific tool + srectl tool migrate --name MyKustoTool + + # Migrate all V1 tools + srectl tool migrate --all + + # Migrate specific tool with dry run + srectl tool migrate --name MyKustoTool --dry-run + + # Preview migration without making changes (dry run) + srectl tool migrate --all --dry-run + show-types Display available tool types and their details + + Examples: + # List all available tool types + srectl tool show-types + + # Show detailed information for all types + srectl tool show-types --verbose + + # Show details for a specific tool type + srectl tool show-types --type KustoTool + + # Show specific type with verbose details + srectl tool show-types --type AzureTool --verbose + show-connectors Display configured data connectors (names to use in YAML) and available connector types + + Examples: + # List all available connectors + srectl tool show-connectors + list List all tools from the remote server + + Examples: + # List all tools + srectl tool list + + # List all tools with full YAML details + srectl tool list --detail + + # Get a specific tool by name (full YAML output) + srectl tool list --name TestMigrate + + # Search for specific tools + srectl tool list --search kusto +``` + +### tool create Command {#tool-create-command} + +``` +$ srectl tool create --help + +Description: + Create a new tool YAML configuration file + +Usage: + srectl tool create [options] + +Common Options: + --name (REQUIRED) Name of the tool + --type (REQUIRED) Type of the tool (KustoTool, LinkTool, PythonTool, HttpClientTool) + --path Custom path under tools directory (e.g., 'StorageOperations') + --description Description of the tool + --parameter Tool parameter in format 'name:type:description' (can be specified multiple times) + +KustoTool Options: + --connector Connector name for the tool + --database Database name for KustoTool + --query Query for KustoTool + + Examples: + # Create a KustoTool with all parameters + srectl tool create --name QueryMetrics --type KustoTool --connector analytics-cluster --database LogsDB --query "MyTable | take 10" --parameter limit + # Create a KustoTool with minimal options + srectl tool create --name GetLogs --type KustoTool --connector logs-cluster --database LogsDB + +LinkTool Options: + --template