KubeWhisper

KubeWhisper is a CLI tool designed to generate kubectl commands from natural language queries, providing an efficient way to manage Kubernetes resources.

Table of Contents

• Installation
• Setup
• Usage
• Features
• Licensing and API Access
• Contributing
• License

Installation

Install KubeWhisper via pip:

pip install kubewhisper

This will make the kubewhisper command available globally.

Setup

To use KubeWhisper, you’ll need an API token for authentication. Follow these steps to set it up:

1. Register: Start by registering with your email and password.

   kubewhisper --register <email> <password>
   

   Check your email for a verification code.

2. Verify: Use the verification code sent to your email to complete the registration.

   kubewhisper --verify <email> <code>
   

3. Authenticate: After verification, authenticate with your credentials.

   kubewhisper --login <email> <password>
   

Once authenticated, your credentials will be securely stored for future use.

Usage

Query Commands

To generate a kubectl command, simply provide your query as an argument:

kubewhisper "create a pod called my-pod"

This will return the suggested kubectl command based on your query.

Auto-complete Execution

To directly execute the generated kubectl command, use the -a or --auto-complete flag:

kubewhisper "list all pods in dev namespace" --auto-complete

If the query is valid, the command will be automatically executed.

History

Retrieve a history of past queries and responses:

kubewhisper --history

Features

• Natural Language Queries: Generate Kubernetes commands using everyday language.
• Authentication: Register and authenticate with the KubeWhisper API for secure access.
• Auto-complete: Option to auto-complete and execute suggested commands.
• Query History: View past queries and responses.

Licensing and API Access

KubeWhisper CLI is open-source software licensed under the AGPL-3.0 license. This license allows you to freely use, modify, and distribute the CLI, but it requires that any modifications or public hosting of the CLI also follow the AGPL-3.0 terms.

API Access: Access to the KubeWhisper API is available through a paid subscription. By using the API, you agree to our API Terms of Service. For more information on subscription plans, visit API Pricing.

Contributing

We welcome contributions! To contribute:

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Open a pull request.

License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.