https://github.com/petricbranko/kubewhisper
AI CLI kubectl assistant
https://github.com/petricbranko/kubewhisper
ai cli devops kubectl kubernetes
Last synced: 5 months ago
JSON representation
AI CLI kubectl assistant
- Host: GitHub
- URL: https://github.com/petricbranko/kubewhisper
- Owner: petricbranko
- License: agpl-3.0
- Created: 2024-10-22T11:31:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-08T09:00:47.000Z (9 months ago)
- Last Synced: 2025-10-08T10:30:44.984Z (9 months ago)
- Topics: ai, cli, devops, kubectl, kubernetes
- Language: Python
- Homepage: https://brankopetric.com/kubewhisper
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](#installation)
- [Setup](#setup)
- [Usage](#usage)
- [Features](#features)
- [Licensing and API Access](#licensing-and-api-access)
- [Contributing](#contributing)
- [License](#license)
## Installation
Install KubeWhisper via pip:
```bash
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.
```bash
kubewhisper --register
```
Check your email for a verification code.
2. **Verify**: Use the verification code sent to your email to complete the registration.
```bash
kubewhisper --verify
```
3. **Authenticate**: After verification, authenticate with your credentials.
```bash
kubewhisper --login
```
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:
```bash
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:
```bash
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:
```bash
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](https://brankopetric.com/kubewhisper). For more information on subscription plans, visit [API Pricing](https://brankopetric.com/kubewhisper).
## 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](LICENSE) file for details.