Tools Command

This guide documents the tool command in the Kubiya CLI, which allows you to search, list, and describe tools across all sources in your Kubiya environment.

Overview

The tool command (aliased as tools) provides access to the automation tools available in your Kubiya environment. You can use this command to discover and learn about the various tools that can help automate your workflows.

Available Commands

List Tools

View all available tools in your environment:

# List all tools
kubiya tool list

# List tools in JSON format
kubiya tool list --output json

# List tools from a specific source
kubiya tool list --source SOURCE_UUID

Example output:

 🛠️  Tools 

deploy-app
  Deploys an application to a Kubernetes cluster
  Arguments:
    • namespace: Kubernetes namespace to deploy to (required)
    • version: Application version to deploy (optional)
  Environment:
    • KUBERNETES_CONFIG ⎈ (Inherited from Kubernetes integration)

scale-service
  Scales a Kubernetes service
  Arguments:
    • name: Service name (required)
    • replicas: Number of replicas (optional)
  Environment:
    • KUBERNETES_CONFIG ⎈ (Inherited from Kubernetes integration)

Search for Tools

Find tools based on keywords:

# Search for tools by keyword
kubiya tool search kubernetes

# Non-interactive search
kubiya tool search deploy --non-interactive

# Get search results in JSON format
kubiya tool search deploy --output json

Example output:

 Top 3 Tools 

1. deploy-app
   Source: kubernetes-tools
   Deploys an application to a Kubernetes cluster

2. deploy-lambda
   Source: aws-tools
   Deploys a Lambda function to AWS

3. deployment-status
   Source: kubernetes-tools
   Checks the status of a Kubernetes deployment

Describe Tool

Get detailed information about a specific tool:

# Describe a tool
kubiya tool describe deploy-app

# Describe a tool from a specific source
kubiya tool describe deploy-app --source SOURCE_UUID

Example output:

 🛠️  Tool: deploy-app 

Source: kubernetes-tools

Description:
Deploys an application to a Kubernetes cluster

Arguments:
  • namespace  Kubernetes namespace to deploy to  (required)
  • version    Application version to deploy  (optional)

Environment Variables:
  • KUBERNETES_CONFIG ⎈ (Inherited from Kubernetes integration)

To execute this tool:
  kubiya browse
  kubiya source interactive

Command Options

Command	Options
list	--output, -o: Output format (text|json) --source, -s: Source UUID to list tools from
search	--output, -o: Output format (text|json) --non-interactive, -n: Non-interactive search mode
describe	--output, -o: Output format (text|json) --source, -s: Source UUID to search in

How It Works

The tool command works by:

1. Connecting to your configured Kubiya environment

2. Retrieving information about available sources and their tools

3. Filtering and displaying the tools based on your command

4. Providing detailed information about specific tools when requested

For search operations, the system uses both exact matching and approximate matching based on Levenshtein distance to find tools related to your query.

Use Cases

Tool Discovery

# List all available tools
kubiya tool list

Finding Specific Tools

# Search for tools related to AWS
kubiya tool search aws

Learning Tool Parameters

# Get detailed information about a specific tool
kubiya tool describe provision-ec2

Troubleshooting

Common Issues and Solutions

1. No Tools Found

   • Verify that your sources are properly configured

   • Check if you have the necessary permissions

   • Try listing all tools with kubiya tool list to see what's available

2. Tool Not Found by Search

   • Try using different keywords

   • Use kubiya tool list to see all available tools

   • Check if the tool name is spelled correctly

3. Source Not Found

   • Use kubiya source list to verify available sources

   • Check if the source UUID is correct

Related Commands

• kubiya generate-tool - Generate a new tool from a description

• kubiya source - Manage sources containing tools

• kubiya browse - Open the Kubiya web interface to execute tools

• kubiya chat - Chat with AI assistants that can execute tools

Conclusion

The tool command in Kubiya CLI provides a powerful way to discover and learn about the automation capabilities available in your environment. By using this command, you can find the right tools for your workflows and understand how to use them effectively.