Skip to content

Latest commit

 

History

History
195 lines (146 loc) · 6.22 KB

README.md

File metadata and controls

195 lines (146 loc) · 6.22 KB
Raw

AIx

Features • Installation • Usage • Running AIx • Join Discord 


	AIx is a cli tool to interact with Large Language Models (LLM) APIs.

image

Features

  • AMA with AI over CLI
  • Query LLM APIs (OpenAI)
  • Supports GPT-3.5 and GPT-4.0 models
  • Configurable with OpenAI API key
  • Flexible output options

Installation

To install aix, you need to have Golang 1.19 installed on your system. You can download Golang from here. After installing Golang, you can use the following command to install aix:

go install github.com/projectdiscovery/aix/cmd/aix@latest

Prerequisite

Note: Before using aix, make sure to set your OpenAI API key as an environment variable OPENAI_API_KEY.

export OPENAI_API_KEY=******

Help Menu

You can use the following command to see the available flags and options:

AIx is a cli tool to interact with Large Language Model (LLM) APIs.

Usage:
  ./aix [flags]

Flags:
INPUT:
   -p, -prompt string[]  prompt to query (input: stdin,string,file)

MODEL:
   -g3, -gpt3         use GPT-3.5 model (default true)
   -g4, -gpt4         use GPT-4.0 model
   -m, -model string  specify model to use (ex: gpt-4-0314)
   -lm, -list-models  list available models

CONFIG:
   -ak, -openai-api-key string    openai api key token (input: string,file,env)
   -t, -temperature string        openai model temperature
   -tp, -topp string              openai model top-p
   -sc, -system-context string[]  system message to send to the model (optional) (string,file)
   -s, -stream                    stream output to stdout (markdown rendering will be disabled)

UPDATE:
   -up, -update                 update aix to latest version
   -duc, -disable-update-check  disable automatic aix update check

OUTPUT:
   -o, -output string  file to write output to
   -j, -jsonl          write output in json(line) format
   -v, -verbose        verbose mode
   -silent             display silent output
   -nc, -no-color      disable colors in cli output
   -version            display project version
   -nm, -no-markdown   skip rendering markdown response

Examples

You can use aix to interact with LLM (OpenAI) APIs to query anything and everything in your CLI by specifying the prompts. Here are some examples:

Example 1: Query LLM with a prompt

aix -p "What is the capital of France?"

Example 2: Query with GPT-4.0 model

aix -p "How to install Linux?" -g4

Example 3: Query LLM API with a prompt with STDIN input

echo list top trending web technologies | aix

   ___   _____  __
  / _ | /  _/ |/_/
 / __ |_/ /_>  < 
/_/ |_/___/_/|_|  Powered by OpenAI

   projectdiscovery.io		  

[INF] Current aix version v0.0.1 (latest)
1. Artificial Intelligence (AI) and Machine Learning (ML)
2. Internet of Things (IoT)
3. Progressive Web Apps (PWA)
4. Voice search and virtual assistants
5. Mobile-first design and development
6. Blockchain and distributed ledger technology
7. Augmented Reality (AR) and Virtual Reality (VR)
8. Chatbots and conversational interfaces
9. Serverless architecture and cloud computing
10. Cybersecurity and data protection
11. Mobile wallets and payment gateways
12. Responsive web design and development
13. Social media integration and sharing options
14. Accelerated Mobile Pages (AMP)
15. Content Management Systems (CMS) and static site generators

Note: These technologies are constantly changing and evolving, so this list is subject to change over time.

Example 4: Query LLM API with a prompt and save the output to a file in JSONLine format.

aix -p "What is the capital of France?" -jsonl -o output.txt | jq .

   ___   _____  __
  / _ | /  _/ |/_/
 / __ |_/ /_>  < 
/_/ |_/___/_/|_|  Powered by OpenAI

   projectdiscovery.io		  

[INF] Current aix version v0.0.1 (latest)
{
  "timestamp": "2023-03-26 17:55:42.707436 +0530 IST m=+1.512222751",
  "prompt": "What is the capital of France?",
  "completion": "Paris.",
  "model": "gpt-3.5-turbo"
}

Example 5: Query LLM API in verbose mode

aix -p "What is the capital of France?" -v

   ___   _____  __
  / _ | /  _/ |/_/
 / __ |_/ /_>  < 
/_/ |_/___/_/|_|  Powered by OpenAI

   projectdiscovery.io		  

[INF] Current aix version v0.0.1 (latest)
[VER] [prompt] What is the capital of France?
[VER] [completion] The capital of France is Paris.

For more information on the usage of aix, please refer to the help menu with the aix -h flag.

Acknowledgements

aix is made with ❤️ by the projectdiscovery team and distributed under MIT License.

Join Discord