diff --git a/README.md b/README.md index 00f4720..223ea85 100644 --- a/README.md +++ b/README.md @@ -46,79 +46,80 @@ cmm [global options] command [command options] The `question` command is used to ask, create, and process questions. ```bash -cmm question [-t OTAGS]... [-k ATAGS]... [-x XTAGS]... [-o OUTTAGS]... [-A AI] [-M MODEL] [-n NUM] [-m MAX] [-T TEMP] (-a ASK | -c CREATE | -r REPEAT | -p PROCESS) [-O] [-s SOURCE]... [-S SOURCE]... +cmm question [-t OTAGS]... [-k ATAGS]... [-x XTAGS]... [-o OUTTAGS]... [-A AI_ID] [-M MODEL] [-n NUM] [-m MAX] [-T TEMP] (-a QUESTION | -c QUESTION | -r [MESSAGE ...] | -p [MESSAGE ...]) [-O] [-s FILE]... [-S FILE]... ``` -* `-t, --or-tags OTAGS` : List of tags (one must match) -* `-k, --and-tags ATAGS` : List of tags (all must match) -* `-x, --exclude-tags XTAGS` : List of tags to exclude -* `-o, --output-tags OUTTAGS` : List of output tags (default: use input tags) -* `-A, --AI AI` : AI ID to use -* `-M, --model MODEL` : Model to use -* `-n, --num-answers NUM` : Number of answers to request -* `-m, --max-tokens MAX` : Max. number of tokens -* `-T, --temperature TEMP` : Temperature value -* `-a, --ask ASK` : Ask a question -* `-c, --create CREATE` : Create a question -* `-r, --repeat REPEAT` : Repeat a question -* `-p, --process PROCESS` : Process existing questions -* `-O, --overwrite` : Overwrite existing messages when repeating them -* `-s, --source-text SOURCE` : Add content of a file to the query -* `-S, --source-code SOURCE` : Add source code file content to the chat history +* `-t, --or-tags OTAGS`: List of tags (one must match) +* `-k, --and-tags ATAGS`: List of tags (all must match) +* `-x, --exclude-tags XTAGS`: List of tags to exclude +* `-o, --output-tags OUTTAGS`: List of output tags (default: use input tags) +* `-A, --AI AI_ID`: AI ID to use +* `-M, --model MODEL`: Model to use +* `-n, --num-answers NUM`: Number of answers to request +* `-m, --max-tokens MAX`: Max. number of tokens +* `-T, --temperature TEMP`: Temperature value +* `-a, --ask QUESTION`: Ask a question +* `-c, --create QUESTION`: Create a question +* `-r, --repeat [MESSAGE ...]`: Repeat a question +* `-p, --process [MESSAGE ...]`: Process existing questions +* `-O, --overwrite`: Overwrite existing messages when repeating them +* `-s, --source-text FILE`: Add content of a file to the query +* `-S, --source-code FILE`: Add source code file content to the chat history #### Hist The `hist` command is used to print the chat history. ```bash -cmm hist [-t OTAGS]... [-k ATAGS]... [-x XTAGS]... [-w] [-W] [-S] [-A ANSWER] [-Q QUESTION] +cmm hist [-t OTAGS]... [-k ATAGS]... [-x XTAGS]... [-w] [-W] [-S] [-A SUBSTRING] [-Q SUBSTRING] ``` -* `-t, --or-tags OTAGS` : List of tags (one must match) -* `-k, --and-tags ATAGS` : List of tags (all must match) -* `-x, --exclude-tags XTAGS` : List of tags to exclude -* `-w, --with-tags` : Print chat history with tags -* `-W, --with-files` : Print chat history with filenames -* `-S, --source-code-only` : Print only source code -* `-A, --answer ANSWER` : Search for answer substring -* `-Q, --question QUESTION` : Search for question substring +* `-t, --or-tags OTAGS`: List of tags (one must match) +* `-k, --and-tags ATAGS`: List of tags (all must match) +* `-x, --exclude-tags XTAGS`: List of tags to exclude +* `-w, --with-tags`: Print chat history with tags +* `-W, --with-files`: Print chat history with filenames +* `-S, --source-code-only`: Only print embedded source code +* `-A, --answer SUBSTRING`: Search for answer substring +* `-Q, --question SUBSTRING`: Search for question substring #### Tags The `tags` command is used to manage tags. ```bash -cmm tags (-l | -p PREFIX | -c CONTENT) +cmm tags (-l | -p PREFIX | -c SUBSTRING) ``` -* `-l, --list` : List all tags and their frequency -* `-p, --prefix PREFIX` : Filter tags by prefix -* `-c, --contain CONTENT` : Filter tags by contained substring +* `-l, --list`: List all tags and their frequency +* `-p, --prefix PREFIX`: Filter tags by prefix +* `-c, --contain SUBSTRING`: Filter tags by contained substring #### Config The `config` command is used to manage the configuration. ```bash -cmm config (-l | -m | -c CREATE) +cmm config (-l | -m | -c FILE) ``` -* `-l, --list-models` : List all available models -* `-m, --print-model` : Print the currently configured model -* `-c, --create CREATE` : Create config with default settings in the given file +* `-l, --list-models`: List all available models +* `-m, --print-model`: Print the currently configured model +* `-c, --create FILE`: Create config with default settings in the given file #### Print The `print` command is used to print message files. ```bash -cmm print -f FILE [-q | -a | -S] +cmm print (-f FILE | -l) [-q | -a | -S] ``` -* `-f, --file FILE` : File to print -* `-q, --question` : Print only question -* `-a, --answer` : Print only answer -* `-S, --only-source-code` : Print only source code +* `-f, --file FILE`: Print given file +* `-l, --latest`: Print latest message +* `-q, --question`: Only print the question +* `-a, --answer`: Only print the answer +* `-S, --only-source-code`: Only print embedded source code ### Examples @@ -160,18 +161,27 @@ cmm print -f example.yaml ## Configuration -The configuration file (`.config.yaml`) should contain the following fields: +The default configuration filename is `.config.yaml` (it is searched in the current working directory). +Use the command `cmm config --create ` to create a default configuration: -- `openai`: - - `api_key`: Your OpenAI API key. - - `model`: The name of the OpenAI model to use (e.g. "text-davinci-002"). - - `temperature`: The temperature value for the model. - - `max_tokens`: The maximum number of tokens for the model. - - `top_p`: The top P value for the model. - - `frequency_penalty`: The frequency penalty value. - - `presence_penalty`: The presence penalty value. -- `system`: The system message used to set the behavior of the AI. -- `db`: The directory where the question-answer pairs are stored in YAML files. +``` +cache: . +db: ./db/ +ais: + myopenai: + name: openai + model: gpt-3.5-turbo-16k + api_key: 0123456789 + temperature: 1.0 + max_tokens: 4000 + top_p: 1.0 + frequency_penalty: 0.0 + presence_penalty: 0.0 + system: You are an assistant +``` + +Each AI has its own section and the name of that section is called the 'AI ID' (in the example above it is `myopenai`). +The AI ID can be any string, as long as it's unique within the `ais` section. The AI ID is used for all commands that support the `AI` parameter and it's also stored within each message file. ## Autocompletion @@ -186,33 +196,33 @@ After adding this line, restart your shell or run `source pyenv install 3.11.4 pyenv virtualenv 3.11.4 py311 @@ -223,5 +233,3 @@ pyenv activate py311 ## License This project is licensed under the terms of the WTFPL License. - -