diff --git a/README.md b/README.md index 92fdea4..04318f9 100644 --- a/README.md +++ b/README.md @@ -162,7 +162,7 @@ See the following pages: AI suggestions should work out of the box with `request-ai` module installed. -An API key is included with the source. It should always work unless I can no longer afford this public service or rate limits are reached. If it's useful to you, **please share this project and spread the word**. Also consider making a donation to keep its public usage alive: +An API key is included with the source (your distribution might have stripped them out). It should always work unless I can no longer afford this public service or rate limits are reached. If it's useful to you, **please share this project and spread the word**. Also consider making a donation to keep its public usage alive:
-
- AI and API Configuration - -> Configuration is done via environment variables: -> -> - `_PR_AI_API_KEY`: Your own API key -> - `_PR_AI_URL`: URL used. Any OpenAI compatible URL can be used, e.g.: -> - `https://api.openai.com/v1/chat/completions` (Note: OpenAI's ChatGPT is very slow) -> - `https://api.groq.com/openai/v1/chat/completions` -> - `_PR_AI_MODEL`: Model used -> - `_PR_AI_DISABLE`: Setting to any value disables AI integration -> - `_PR_AI_LOCALE`: Locale in which the AI explains the suggestion. Defaults to user system locale - -> Compile time variables: Default values for the respective variables above when not set -> -> - `_DEF_PR_AI_API_KEY` -> - `_DEF_PR_AI_URL` -> - `_DEF_PR_AI_MODEL` -> -> If default values were not provided, pay-respects' own values will be used. Your request will be filtered to avoid abuse usages. Request will then be forwarded to a LLM provider that will not use your data for training. - -
+[AI and API configurations](./module-request-ai/README.md) ## Contributing diff --git a/module-request-ai/README.md b/module-request-ai/README.md new file mode 100644 index 0000000..34d0d33 --- /dev/null +++ b/module-request-ai/README.md @@ -0,0 +1,69 @@ +# Request AI Module + +Module for [pay-respects](https://codeberg.org/iff/pay-respects) to request AI for suggestions. + +Compile time features: + +- `libcurl` (default): Dynamically links to libcurl. Requires OpenSSL when compiling. When disabled, a curl process is spawned instead. + +## Configurations + +Configuration is done via environment variables: + +- `_PR_AI_API_KEY`: Your own API key +- `_PR_AI_URL`: URL used. Any OpenAI compatible URL can be used, e.g.: + - `https://api.openai.com/v1/chat/completions` (Note: OpenAI's ChatGPT is very slow) + - `https://api.groq.com/openai/v1/chat/completions` + - `http://localhost:11434/api/chat`: Ollama +- `_PR_AI_MODEL`: Model used +- `_PR_AI_DISABLE`: Setting to any value disables AI integration +- `_PR_AI_LOCALE`: Locale in which the AI explains the suggestion. Defaults to user system locale + +Compile time variables: Default values for the respective variables above when not set + +- `_DEF_PR_AI_API_KEY` +- `_DEF_PR_AI_URL` +- `_DEF_PR_AI_MODEL` + +If default values were not provided, pay-respects' own values will be used. Your request will be filtered to avoid abuse usages. Request will then be forwarded to a LLM provider that will not use your data for training. This service is provided free and is not guaranteed to always work. Donations would be appreciated: + +
+ Donate using Liberapay + Donate using Ko-fi +
+ Donate using Stripe + Donate using PayPal +
+ diff --git a/module-runtime-rules/README.md b/module-runtime-rules/README.md new file mode 100644 index 0000000..c54e0af --- /dev/null +++ b/module-runtime-rules/README.md @@ -0,0 +1,13 @@ +# Runtime Rules Module + +Module for [pay-respects](https://codeberg.org/iff/pay-respects) which allows you to parse rules at runtime. + +Syntax is currently 100% compatible with [upstream's compile-time rules](https://codeberg.org/iff/pay-respects/src/branch/main/rules.md). + +Rules are searched in these directories: + +- `XDG_CONFIG_HOME`, defaults to `$HOME/.config`. +- `XDG_CONFIG_DIRS`, defaults to `/etc/xdg`. +- `XDG_DATA_DIRS`, defaults to `/usr/local/share:/usr/share`. + +The actual rule file should be placed under `pay-respects/rules/`, for example: `~/.config/pay-respects/rules/cargo.toml`. To avoid parsing unnecessary rules, the name of the file **MUST** match the command name.