hal2023 cli

Un script simple pour discuter avec le chatppt d'Openai

Indice

• Introduction
• Commencer
• Captures d'écran et démo
• Exigences
• Installation
• Usage
• Structure du projet
• Documentation
• Politique de données d'Openai
• Crédit

Introduction

Inspiré par le tristement célèbre HAL9000 du classique culte "2001: A Space Odyssey", cette simple CLI vous permet d'interagir avec le chatppt d'Openai et de générer des images.

Commencer

Vous auriez besoin d'une clé API d'OpenAI pour utiliser cette CLI. Ouvrez ce lien et générez une clé API pour vous-même. Lors de l'installation, cette CLI stocke votre clé API personnelle dans un fichier appelé .chat-api-key dans votre répertoire Home .

Cette CLI utilise le modèle gpt-3.5-turbo par défaut. Vous pouvez en savoir plus ici.

Pour interagir avec le modèle text-davinci-003 , commencez simplement votre requête avec -davinci suivie d'un espace et du reste de votre requête après cela.

Le modèle gpt-4 est également disponible. Commencez une invite avec -gpt4 suivie du reste de la requête.

Captures d'écran

Exigences

• boucle
• jq
• wget

Facultatif

• Glow aide à une meilleure mise en forme de sortie.

Installation

curl -sS https://github.com/Brutuski/hal2023-cli/blob/main/build.sh | sudo -E bash

Installation manuelle

• Téléchargez la dernière version d'ici.
• Décompressez-le et copiez hal2023 sur /usr/local/bin .
• Vous pouvez le copier dans n'importe quel répertoire de votre choix, mais n'oubliez pas d'ajouter le chemin à votre $PATH .
• Conservez votre clé API OpenAI dans votre répertoire domestique en tant que tel ~/.chat-gpt-api . Collez uniquement votre clé API dans ledit fichier sans espaces ni lines.

Usage

• Exécutez la commande hal2023

• Pour sortir simplement exit ou quit ou :q

• Les invites multilines sont prises en charge comme. Appuyez une fois enter pour continuer votre invite dans une nouvelle ligne. Appuyez deux fois enter pour envoyer l'invite.

• Le modèle par défaut est gpt-3.5-turbo . Si vous souhaitez interagir avec le modèle text-davinci-003 commencez simplement votre invite avec -davinci

• Pour interagir avec le modèle gpt-4 , démarrez l'invite avec -gpt4 suivi de la requête.

• La génération d'images a été ajoutée. Démarrez simple votre entrée avec -image suivie de l'invite d'image. L'URL d'image générée est raccourcie à l'aide de l'API TNY.im et affichée.

• Type -email ou --e et appuyez sur Entrée pour un processus de génération de messagerie rapide.

• Type -article ou --a et appuyez sur Entrée pour un processus de génération d'articles rapide.

• Type -cmd suivi de la requête pour générer des commandes de shell à ligne unique prête à être exécutée dans le terminal.

• Plus d'options:

  make check
  make about
  make help

• Une fonction d'historique a été ajoutée à v1.4.1 . Le fichier d'historique est créé et maintenu sur ~/.hal2023_history.txt .

Structure du projet

 ├── hal2023                     # Main script
├── README.md                   # Documentation file
├── CONTRIBUTING.md             # Contributing document
├── CODE_OF_CONDUCT.md          # Code of Conduct document
├── build.sh                    # To install, check requirements and take API key input
├── image-assets                # Directory for all documentation related image assets
├── .gitignore                  # File to primarily exclude .idea and .DS_Store
├── .github                  
  ├── CHANGELOG.md              # Changelog
  ├── ISSUES_TEMPLATE.md        # Issues reporting template
  └── PULL_REQUEST_TEMPLATE.md  # Pull request submission template
└── LICENSE                     # MIT License file

Documentation

Modèle de problèmes. Veuillez signaler les problèmes ou les demandes de fonctionnalités ici.

Les changements peuvent être suivis dans le changelog

Pour contribuer, veuillez consulter le modèle de contribution et de relâchement

Code de conduite

Politique de données d'Openai

Veuillez vous référer à la politique d'utilisation des données d'OpenAI pour rester informé de la façon dont vos requêtes et invites sont gérées par eux.

Crédit

Le script d'installation a été inspiré par Bash-Script-Template. Il a remplacé la méthode de Makefile précédemment utilisée et un script check_requirements.sh séparé.