updaates to readme, docs, added some logging in case goal setting goes bad

This commit is contained in:
Joshua Smith
2025-03-19 08:08:38 -04:00
parent c20f5d796f
commit 850404e0d5
6 changed files with 66 additions and 49 deletions

View File

@@ -1,4 +1,5 @@
## Configuration
# Setup Guide
## Initial Configuration
This application uses `.env` files for configuration. Copy the [.env.example](.env.example) file to `.env` and update the values:
@@ -6,6 +7,12 @@ This application uses `.env` files for configuration. Copy the [.env.example](.e
cp .env.example .env
```
Then add API keys, configuration, as desired.
If you want to show confirmations/enable the debugging UI, set
```bash
SHOW_CONFIRM=True
```
### Agent Goal Configuration
The agent can be configured to pursue different goals using the `AGENT_GOAL` environment variable in your `.env` file.
@@ -173,4 +180,6 @@ If you're running your train API above on a different host/port then change the
- `tool_registry.py` contains the mapping of tool names to tool definitions (so the AI understands how to use them)
- `goal_registry.py` contains descriptions of goals and the tools used to achieve them
- The tools themselves are defined in their own files in `/tools`
- Note the mapping in `tools/__init__.py` to each tool
- Note the mapping in `tools/__init__.py` to each tool
For more details, check out [adding goals and tools guide](./adding-goals-and-tools.md).