f63419c78b
* updated local llm documentation * updated cli flags to be consistent with documentation * added preset documentation * update test to use new arg * update test to use new arg
46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
### Configuring the agent
|
|
You can set agent defaults by running `memgpt configure`, which will store config information at `~/.memgpt/config` by default.
|
|
|
|
The `memgpt run` command supports the following optional flags (if set, will override config defaults):
|
|
|
|
* `--agent`: (str) Name of agent to create or to resume chatting with.
|
|
* `--human`: (str) Name of the human to run the agent with.
|
|
* `--persona`: (str) Name of agent persona to use.
|
|
* `--model`: (str) LLM model to run (e.g. `gpt-4`, `dolphin_xxx`)
|
|
* `--preset`: (str) MemGPT preset to run agent with.
|
|
* `--first`: (str) Allow user to sent the first message.
|
|
* `--debug`: (bool) Show debug logs (default=False)
|
|
* `--no-verify`: (bool) Bypass message verification (default=False)
|
|
* `--yes`/`-y`: (bool) Skip confirmation prompt and use defaults (default=False)
|
|
|
|
You can override the parameters you set with `memgpt configure` with the following additional flags specific to local LLMs:
|
|
|
|
* `--model-wrapper`: (str) Model wrapper used by backend (e.g. `airoboros_xxx`)
|
|
* `--model-endpoint-type`: (str) Model endpoint backend type (e.g. lmstudio, ollama)
|
|
* `--model-endpoint`: (str) Model endpoint url (e.g. `localhost:5000`)
|
|
* `--context-window`: (int) Size of model context window (specific to model type)
|
|
|
|
#### Updating the config location
|
|
You can override the location of the config path by setting the environment variable `MEMGPT_CONFIG_PATH`:
|
|
```
|
|
export MEMGPT_CONFIG_PATH=/my/custom/path/config # make sure this is a file, not a directory
|
|
```
|
|
|
|
|
|
### Adding Custom Personas/Humans
|
|
You can add new human or persona definitions either by providing a file (using the `-f` flag) or text (using the `--text` flag).
|
|
```sh
|
|
# add a human
|
|
memgpt add human [--name <NAME>] [-f <FILENAME>] [--text <TEXT>]
|
|
|
|
# add a persona
|
|
memgpt add persona [--name <NAME>] [-f <FILENAME>] [--text <TEXT>]
|
|
```
|
|
|
|
You can view available persona and human files with the following command:
|
|
```sh
|
|
memgpt list [humans/personas]
|
|
```
|
|
|
|
### Custom Presets
|