aiac

command module
v2.1.1 Latest Latest
Warning

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

Go to latest
Published: Mar 16, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

README

AIAC AIAC

Artificial Intelligence Infrastructure-as-Code Generator.

demo

Description

aiac is a command line tool to generate IaC (Infrastructure as Code) templates, configurations, utilities, queries and more via OpenAI's API. The CLI allows you to ask the model to generate templates for different scenarios (e.g. "get terraform for AWS EC2"). It will make the request, and store the resulting code to a file, or simply print it to standard output. By default, aiac uses the same model used by ChatGPT, but allows using different models.

Use Cases and Example Prompts

Generate IaC
  • aiac get terraform for a highly available eks
  • aiac get pulumi golang for an s3 with sns notification
  • aiac get cloudformation for a neptundb
Generate Configuration Files
  • aiac get dockerfile for a secured nginx
  • aiac get k8s manifest for a mongodb deployment
Generate CICD Pipelines
  • aiac get jenkins pipeline for building nodejs
  • aiac get github action that plans and applies terraform and sends a slack notification
Generate Policy as Code
  • aiac get opa policy that enforces readiness probe at k8s deployments
Generate Utilities
  • aiac get python code that scans all open ports in my network
  • aiac get bash script that kills all active terminal sessions
Command Line Builder
  • aiac get kubectl that gets ExternalIPs of all nodes
  • aiac get awscli that lists instances with public IP address and Name
Query Builder
  • aiac get mongo query that aggregates all documents by created date
  • aiac get elastic query that applies a condition on a value greater than some value in aggregation
  • aiac get sql query that counts the appearances of each row in one table in another table based on an id column

Instructions

You will need to provide an OpenAI API key in order for aiac to work. Refer to OpenAI's pricing model for more information. As of this writing, you get $5 in free credits upon signin up, but generally speaking, this is a paid API.

Installation

Via brew:

brew install gofireflyio/aiac/aiac

Using docker:

docker pull ghcr.io/gofireflyio/aiac

Using go install:

go install github.com/gofireflyio/aiac/v2@latest

Alternatively, clone the repository and build from source:

git clone https://github.com/gofireflyio/aiac.git
go build
Usage
  1. Create your OpenAI API key here.
  2. Click “Create new secret key” and copy it.
  3. Provide the API key via the OPENAI_API_KEY environment variable or via the --api-key command line flag.

By default, aiac prints the extracted code to standard output and asks if it should save the code, regenerate it, or modify the prompt:

aiac get terraform for AWS EC2

To store the resulting code to a file:

aiac -o aws_ec2.tf get terraform for AWS EC2

To run using docker:

docker run \
-it \
-e OPENAI_API_KEY=[PUT YOUR KEY HERE] \
ghcr.io/gofireflyio/aiac get terraform for ec2

If you want to receive and/or store the complete Markdown output from OpenAI, including explanations (if any), use the --full flag.

Choosing a Different Model

Use the --model flag to select a different model than the default (currently "gpt-3.5-turbo"). Not all OpenAI models are supported, use aiac list-models to get a list of all supported models.

Example Output

Command line prompt:

aiac get dockerfile for nodejs with comments

Output:

FROM node:latest

# Create app directory
WORKDIR /usr/src/app

# Install app dependencies
# A wildcard is used to ensure both package.json AND package-lock.json are copied
# where available (npm@5+)
COPY package*.json ./

RUN npm install
# If you are building your code for production
# RUN npm ci --only=production

# Bundle app source
COPY . .

EXPOSE 8080
CMD [ "node", "index.js" ]

Troubleshooting

aiac is a command line client to OpenAI's API. Most errors that you are likely to encounter are coming from this API. Some common errors you may encounter are:

  • "[insufficient_quota] You exceeded your current quota, please check your plan and billing details": As described in the Instructions section, OpenAI is a paid API with a certain amount of free credits given. This error means you have exceeded your quota, whether free or paid. You will need to top up to continue usage.

  • "[tokens] Rate limit reached...": The OpenAI API employs rate limiting as described here. aiac only performs individual requests and cannot workaround or prevent these rate limits. If you are using aiac in an application, you will have to implement throttling yourself.

Support Channels

We have two main channels for supporting AIaC:

  1. Slack community: general user support and engagement.
  2. GitHub Issues: bug reports and enhancement requests.

License

This code is published under the terms of the Apache License 2.0.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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