From 9e6f8e8d037a477c55939ece36ab7b000f876e85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jason=20K=C3=B6lker?= Date: Wed, 24 Jan 2024 02:00:07 +0000 Subject: feat(chat): add `include` role to include files Files may be included in the chat by a special `include` role. Each file's contents will be added to an additional `user` role message with the files separated by `==> {path} <==` where `{path}` is the path to the file. Globbing is expanded out via `glob.glob` and relative apths to the current working directory (as determined by `getcwd()`) will be resolved to absolute paths. Example: ``` >>> user Generate documentation for the following files >>> include /home/user/myproject/src/../requirements.txt /home/user/myproject/**/*.py ``` Fixes: #69 --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index fa505dd..993e762 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,22 @@ You are a Clean Code expert, I have the following code, please refactor it in a ``` -Supported chat roles are **`>>> system`**, **`>>> user`** and **`<<< assistant`** +To include files in the chat a special `include` role is used: + +``` +>>> user + +Generate documentation for the following files + +>>> include + +/home/user/myproject/requirements.txt +/home/user/myproject/**/*.py +``` + +Each file's contents will be added to an additional `user` role message with the files separated by `==> {path} <==`, where path is the path to the file. Globbing is expanded out via `glob.gob` and relative paths to the current working directory (as determined by `getcwd()`) will be resolved to absolute paths. + +Supported chat roles are **`>>> system`**, **`>>> user`**, **`>>> include`** and **`<<< assistant`** ### `:AINewChat` -- cgit v1.2.3