From 3bb2900bfd6599fa4f1485691e839537e416ffe6 Mon Sep 17 00:00:00 2001 From: Divan Visagie Date: Thu, 20 Jun 2024 07:36:01 +0200 Subject: [PATCH] Bump version to 0.2.10 and update man pages - Updated version number from 0.2.9 to 0.2.10 in Cargo.toml. - Modified the man page (docs/cgip.1) to reflect the new version. - Updated the man page SYNOPSIS section to correctly mention options and commands. - Added a more detailed description to the man page. - Included new options in the man page such as `--system-prompt` and `--no-session`. - Cleaned up the man page by removing redundant Options section under Commands. - Updated build_deb.sh script to use the new version number. --- Cargo.toml | 2 +- docs/cgip.1 | 36 +++++++++++++----------------------- scripts/build_deb.sh | 2 +- 3 files changed, 15 insertions(+), 25 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 0271f3c..3b39fd7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "cgip" -version = "0.2.9" +version = "0.2.10" edition = "2021" repository = "https://github.com/divanvisagie/chat-gipity" authors = ["Divan Visagie "] diff --git a/docs/cgip.1 b/docs/cgip.1 index 296947b..154e3fc 100644 --- a/docs/cgip.1 +++ b/docs/cgip.1 @@ -1,10 +1,12 @@ -.TH CGIP 1 "2024-06-09" "version 0.2.9" "CGIP MAN PAGE" +.TH CGIP 1 "2024-06-20" "version 0.2.10" "CGIP MAN PAGE" .SH NAME cgip \- interact with ChatGPT based on contextual input from files or standard input. .SH SYNOPSIS .B cgip -[OPTION]... [QUERY] +[OPTIONS] [QUERY] | [COMMAND] .SH DESCRIPTION +Terminal client for interacting with Chat GPT that allows you to build and manipulate contexts. + Queries can be piped in through stdin and will be added to the context first. The query passed in as the first argument will then be added to the context second. Files read using \fB\-f\fR will be added last to the context. .SH COMMANDS .TP @@ -22,24 +24,6 @@ export CGIP_SESSION_NAME=$(uuid) # for each new terminal session to be unique export CGIP_SESSION_NAME=$(date -I) # for a session that will be the same for the entire day .P .RE -Options: -.RS -.P -\fB-c\fR, \fB\-\-clear\fR -Clear the current session context. -.P -\fB-v\fR, \fB\-\-view\fR -View the current session context. -.P -\fB-h\fR, \fB\-\-help\fR -Print help. -.P -\fB-V\fR, \fB\-\-version\fR -Print version. -.RE -.TP -\fBhelp\fR -Print this message or the help of the given subcommand(s). .SH ARGUMENTS .TP \fB[QUERY]\fR @@ -49,6 +33,9 @@ Optional. The primary query to send to the model. This is added to the context a \fB\-f\fR, \fB\-\-file=FILE\fR Read query from a file. If a query is present, it is added to the prompt after the query. If this option is present, stdin is ignored. .TP +\fB\-s\fR, \fB\-\-system\-prompt=SYSTEM_PROMPT\fR +Specify a system prompt. +.TP \fB\-M\fR, \fB\-\-model=MODEL\fR Specify the model to use. Defaults to `gpt-4`. .TP @@ -64,6 +51,9 @@ Output the full context used in the query, including chat context with all assis \fB\-m\fR, \fB\-\-markdown\fR Show context in a human-readable table. .TP +\fB\-n\fR, \fB\-\-no\-session\fR +Don't use messages from the session in this request. +.TP \fB\-h\fR, \fB\-\-help\fR Print help (see more with '--help'). .TP @@ -74,13 +64,13 @@ Print version. To pipe input from 'ls' and query about the files: .P .RS -ls | \fBcgip\fR "What can you tell me about these files?"\f +ls | \fBcgip\fR "What can you tell me about these files?" .P .RE To debug a failing build output: -.RS .P -cargo build \fB2>&1\fR | \fBcgip\fR "What does this error mean?"\f +.RS +cargo build 2>&1 | \fBcgip\fR "What does this error mean?" .RE .SH AUTHOR Written by Divan Visagie and Anna L. Smith. diff --git a/scripts/build_deb.sh b/scripts/build_deb.sh index 1539651..08bdc8d 100755 --- a/scripts/build_deb.sh +++ b/scripts/build_deb.sh @@ -5,7 +5,7 @@ set -e # Variables PACKAGE_NAME=cgip -VERSION=0.2.9 +VERSION=0.2.10 ARCHITECTURE=amd64 DEBIAN_FOLDER=debian_package BUILD_FOLDER=$DEBIAN_FOLDER/$PACKAGE_NAME-$ARCHITECTURE-$VERSION