Generate Tool Command

This guide documents the generate-tool command in the Kubiya CLI, which allows you to create new automation tools using AI assistance based on natural language descriptions.

Overview

The generate-tool command enables you to generate automation tools by providing a natural language description. The system uses AI to interpret your description and generate the necessary code files for implementing the tool.

Basic Usage

To generate a tool using a natural language description:

# Generate a tool with a description
kubiya generate-tool "A tool that deploys a containerized application to Kubernetes"

The command will create a new session directory and generate the necessary files for implementing the tool based on your description.

Command Options

The generate-tool command supports the following options:

Option	Description
--session-id	Session ID for continuing previous generation
--target, -t	Target directory for generated files (default: current directory)
--debug	Enable debug logging

Example with Options

# Generate a tool with a custom session ID and specific target directory
kubiya generate-tool "A tool to backup a database" --session-id "db-backup-tool" --target "./my-tools"

# Generate a tool with debug logging
kubiya generate-tool "A monitoring dashboard generator" --debug

How It Works

When you run the generate-tool command:

1. A session directory is created (either in the current directory or at the specified target location)

2. A session ID is generated (or used if provided)

3. Your natural language description is sent to the Kubiya AI service

4. Generated file contents are received and saved to the session directory

5. Debug logs are created if debug mode is enabled

Output

The command provides real-time feedback as it generates your tool:

📁 Using session directory: /path/to/current/directory/gen-1632145987
🎯 Generating tool from description: A tool that deploys a containerized application to Kubernetes
🔑 Using session ID: gen-1632145987

🚀 Starting tool generation...
📥 Writing file: deploy-app.py
✅ Created file: deploy-app.py (1250 bytes)
📥 Writing file: requirements.txt
✅ Created file: requirements.txt (58 bytes)
📥 Writing file: README.md
✅ Created file: README.md (524 bytes)

✨ Tool generation completed successfully in: /path/to/current/directory/gen-1632145987

Use Cases

Rapid Prototyping

Generate the initial structure and code for tools to speed up development:

kubiya generate-tool "A tool that validates AWS CloudFormation templates"

Learning and Exploration

Create example tools to learn about specific technologies or APIs:

kubiya generate-tool "A tool demonstrating how to use the Kubernetes client library"

Automation Development

Quickly scaffold automation tools for common tasks:

kubiya generate-tool "A tool that synchronizes data between two databases"

Troubleshooting

Common Issues and Solutions

1. No Files Created

   • Make your description more specific and detailed

   • Check your network connection

   • Verify the Kubiya service is accessible

2. Permission Issues

   • Ensure you have write permissions for the target directory

   • Try using a different target directory with --target

3. Debugging

   • Use the --debug flag to generate detailed logs

   • Check the debug.log file in the session directory for error details

Related Commands

• kubiya tool list - List available tools

• kubiya tool search - Search for tools by keyword

• kubiya tool describe - Show detailed information about a tool

Conclusion

The generate-tool command provides an AI-powered approach to creating automation tools. By describing what you want to build in natural language, you can quickly generate functional tool implementations that can be further customized to meet your specific requirements.