kuzco

command module
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

README

Kuzco

Enhance your Terraform and OpenTofu configurations with intelligent analysis powered by local LLMs

Introduction

Here's the problem: You spin up a Terraform or OpenTofu resource, pull a basic configuration from the registry, and start wondering what other parameters should be enabled to make it more secure and efficient. Sure, you could use tools like TLint or TFSec, but kuzco saves you time by avoiding the need to dig through the Terraform registry and decipher unclear options. It leverages local LLMs to recommend what should be enabled and configured. Simply put, kuzco reviews your Terraform and OpenTofu resources, compares them to the provider schema to detect unused parameters, and uses AI to suggest improvements for a more secure, reliable, and optimized setup.

Demo

Installation

[!NOTE] To use kuzco, Ollama must be installed. You can do this by running brew bundle install or brew install ollama. For more information on customizing Ollama models for tailored Kuzco responses, check out Customizing Ollama

Homebrew
brew install kuzco
Go

If you have a functional Go environment, you can install with:

go install github.com/RoseSecurity/kuzco@latest
Apt

To install packages, you can quickly setup the repository automatically:

curl -1sLf \
  'https://dl.cloudsmith.io/public/rosesecurity/kuzco/setup.deb.sh' \
  | sudo -E bash

Once the repository is configured, you can install with:

apt install kuzco=<VERSION>
Source
git clone git@github.com:RoseSecurity/Kuzco.git
cd Kuzco
make build

Usage

The following configuration options are available:

❯ kuzco

██   ██ ██    ██ ███████  ██████  ██████
██  ██  ██    ██    ███  ██      ██    ██
█████   ██    ██   ███   ██      ██    ██
██  ██  ██    ██  ███    ██      ██    ██
██   ██  ██████  ███████  ██████  ██████


Intelligently analyze your Terraform and OpenTofu configurations to receive personalized recommendations and fixes for boosting efficiency, security, and performance.

Usage:
  kuzco [flags]
  kuzco [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  fix         Diagnose configuration errors
  help        Help about any command
  recommend   Intelligently analyze your Terraform and OpenTofu configurations
  version     Print the CLI version

Flags:
  -h, --help   help for kuzco

Use "kuzco [command] --help" for more information about a command.

Contributing

For bug reports & feature requests, please use the issue tracker.

PRs are welcome! We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

[!TIP] Be sure to merge the latest changes from "upstream" before making a pull request!

Many Thanks to Our Contributors

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL