https://github.com/zackees/askai

https://github.com/zackees/askai

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/zackees/askai
• Owner: zackees
• License: mit
• Created: 2024-07-22T20:13:18.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-25T02:33:24.000Z (2 months ago)
• Last Synced: 2024-10-26T15:39:22.314Z (2 months ago)
• Language: Python
• Size: 85.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# advanced-askai

[![Linting](../../actions/workflows/lint.yml/badge.svg)](../../actions/workflows/lint.yml)

[![MacOS_Tests](../../actions/workflows/push_macos.yml/badge.svg)](../../actions/workflows/push_macos.yml)

[![Ubuntu_Tests](../../actions/workflows/push_ubuntu.yml/badge.svg)](../../actions/workflows/push_ubuntu.yml)

[![Win_Tests](../../actions/workflows/push_win.yml/badge.svg)](../../actions/workflows/push_win.yml)

This package allows you to have a chat conversation with AI right from your terminal.

Results are streamed to the console.

It has api bindings to allow programatic access and can be used for other tools.

The api key is stored using the secure keyring package. Right now we only support

OpenAI's chatbot, but in the future I hope to include support for anthropics.

The only stable api in this package is located at `advanced_askai.api`

Binding to any other module in this library is subject to break.

# Help

```

usage: Ask OpenAI for help with code

positional arguments:

  prompt                Prompt to ask OpenAI

options:

  -h, --help            show this help message and exit

  --input-file INPUT_FILE

                        Input file containing prompts

  --json                Print response as json

  --set-key SET_KEY     Set OpenAI key

  --output OUTPUT       Output file

  --advanced            bleeding edge model: gpt-4o

  --model MODEL

  --verbose

  --no-stream

  --assistant-prompt ASSISTANT_PROMPT

  --assistant-prompt-file ASSISTANT_PROMPT_FILE

                        File containing assistant prompt

  --max-tokens MAX_TOKENS

                        Max tokens to return

  --code                Code mode: enables aider mode

  --check               Sends the response back to the chatbot for a second opinion

```

See advanced_askai.api.*

# Develope

To develop software, run `. ./activate.sh`

# Windows

This environment requires you to use `git-bash`.

# Linting

Run `./lint.sh` to find linting errors using `pylint`, `flake8` and `mypy`.

# Releases

1.0.1 - If the max tokens goes negative, just set it to 16000.