-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
215 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
.\" Man page generated from reStructuredText. | ||
. | ||
. | ||
.nr rst2man-indent-level 0 | ||
. | ||
.de1 rstReportMargin | ||
\\$1 \\n[an-margin] | ||
level \\n[rst2man-indent-level] | ||
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] | ||
- | ||
\\n[rst2man-indent0] | ||
\\n[rst2man-indent1] | ||
\\n[rst2man-indent2] | ||
.. | ||
.de1 INDENT | ||
.\" .rstReportMargin pre: | ||
. RS \\$1 | ||
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] | ||
. nr rst2man-indent-level +1 | ||
.\" .rstReportMargin post: | ||
.. | ||
.de UNINDENT | ||
. RE | ||
.\" indent \\n[an-margin] | ||
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] | ||
.nr rst2man-indent-level -1 | ||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] | ||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u | ||
.. | ||
.TH "C" "1" "Jan 03, 2025" "0.1.0" "Command Line Assistant" | ||
.SH NAME | ||
c \- Command Line Assistant Client | ||
.sp | ||
A script with multiple optional arguments and a required positional argument if no optional arguments are provided. | ||
.INDENT 0.0 | ||
.INDENT 3.5 | ||
.sp | ||
.EX | ||
c [\-h] [\-\-version] {query,history,record} ... | ||
.EE | ||
.UNINDENT | ||
.UNINDENT | ||
.SH C OPTIONS | ||
.INDENT 0.0 | ||
.IP \(bu 2 | ||
\fI\%\-h\fP, \fI\%\-\-help\fP \- show this help message and exit | ||
.IP \(bu 2 | ||
\fI\%\-\-version\fP \- Show command line assistant version and exit. | ||
.UNINDENT | ||
.SH C QUERY | ||
.sp | ||
Ask a question and get an answer from LLM. | ||
.INDENT 0.0 | ||
.INDENT 3.5 | ||
.sp | ||
.EX | ||
c query [\-h] [query_string] | ||
.EE | ||
.UNINDENT | ||
.UNINDENT | ||
.SS c query positional arguments | ||
.INDENT 0.0 | ||
.IP \(bu 2 | ||
\fI\%query_string\fP \- Query string to be processed. (default: \fBNone\fP) | ||
.UNINDENT | ||
.SS c query options | ||
.INDENT 0.0 | ||
.IP \(bu 2 | ||
\fI\%\-h\fP, \fI\%\-\-help\fP \- show this help message and exit | ||
.UNINDENT | ||
.SH C HISTORY | ||
.sp | ||
Manage conversation history | ||
.INDENT 0.0 | ||
.INDENT 3.5 | ||
.sp | ||
.EX | ||
c history [\-h] [\-\-clear] [\-\-first] [\-\-last] | ||
.EE | ||
.UNINDENT | ||
.UNINDENT | ||
.SS c history options | ||
.INDENT 0.0 | ||
.IP \(bu 2 | ||
\fI\%\-h\fP, \fI\%\-\-help\fP \- show this help message and exit | ||
.IP \(bu 2 | ||
\fI\%\-\-clear\fP \- Clear the history. | ||
.IP \(bu 2 | ||
\fI\%\-\-first\fP \- Get the first conversation from history. | ||
.IP \(bu 2 | ||
\fI\%\-\-last\fP \- Get the last conversation from history. | ||
.UNINDENT | ||
.SH C RECORD | ||
.sp | ||
Start a recording session for script output. | ||
.INDENT 0.0 | ||
.INDENT 3.5 | ||
.sp | ||
.EX | ||
c record [\-h] [\-\-output\-file OUTPUT_FILE] | ||
.EE | ||
.UNINDENT | ||
.UNINDENT | ||
.SS c record options | ||
.INDENT 0.0 | ||
.IP \(bu 2 | ||
\fI\%\-h\fP, \fI\%\-\-help\fP \- show this help message and exit | ||
.IP \(bu 2 | ||
\fI\%\-\-output\-file\fP \fBOUTPUT_FILE\fP \- The place where to store the output file. (default: \fBNone\fP) | ||
.UNINDENT | ||
.INDENT 0.0 | ||
.TP | ||
.B Asking a question: | ||
$ c query \(dqHow do I check disk space?\(dq | ||
.sp | ||
$ c \(dqHow do I check disk space?\(dq | ||
.TP | ||
.B Check all history entries: | ||
$ c history | ||
.TP | ||
.B Check the first entry: | ||
$ c history \-\-first | ||
.TP | ||
.B Check the last entry: | ||
$ c history \-\-last | ||
.TP | ||
.B Clear all the history entries: | ||
$ c history \-\-clear | ||
.UNINDENT | ||
.sp | ||
\fBclad(8)\fP | ||
.SH AUTHOR | ||
RHEL Lightspeed Team | ||
.SH COPYRIGHT | ||
2024, RHEL Lightspeed Team | ||
.\" Generated by docutils manpage writer. | ||
. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
.\" Man page generated from reStructuredText. | ||
. | ||
. | ||
.nr rst2man-indent-level 0 | ||
. | ||
.de1 rstReportMargin | ||
\\$1 \\n[an-margin] | ||
level \\n[rst2man-indent-level] | ||
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] | ||
- | ||
\\n[rst2man-indent0] | ||
\\n[rst2man-indent1] | ||
\\n[rst2man-indent2] | ||
.. | ||
.de1 INDENT | ||
.\" .rstReportMargin pre: | ||
. RS \\$1 | ||
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] | ||
. nr rst2man-indent-level +1 | ||
.\" .rstReportMargin post: | ||
.. | ||
.de UNINDENT | ||
. RE | ||
.\" indent \\n[an-margin] | ||
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] | ||
.nr rst2man-indent-level -1 | ||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] | ||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u | ||
.. | ||
.TH "CLAD" "8" "Jan 03, 2025" "0.1.0" "Command Line Assistant" | ||
.SH NAME | ||
clad \- Command Line Assistant Daemon | ||
.SH SYNOPSIS | ||
.sp | ||
\fBclad\fP | ||
.SH DESCRIPTION | ||
.sp | ||
The Command Line Assistant daemon (clad) provides the backend service for processing queries through D\-Bus. | ||
.SH FILES | ||
.INDENT 0.0 | ||
.TP | ||
.B \fI/etc/xdg/command\-line\-assistant/config.toml\fP | ||
System configuration file | ||
.TP | ||
.B \fI/var/lib/command\-line\-assistant/history.json\fP | ||
History storage file | ||
.UNINDENT | ||
.SH SEE ALSO | ||
.sp | ||
\fBc(1)\fP | ||
.SH AUTHOR | ||
RHEL Lightspeed Team | ||
.SH COPYRIGHT | ||
2024, RHEL Lightspeed Team | ||
.\" Generated by docutils manpage writer. | ||
. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters