diff --git a/README.md b/README.md index 40d726861e..f71f34702f 100644 --- a/README.md +++ b/README.md @@ -90,8 +90,13 @@ You can run the following commands in the MemGPT CLI prompt: * `/attach`: Attach a loaded data source to the agent * `/save`: Save a checkpoint of the current agent/conversation state * `/dump`: View the current message log (see the contents of main context) +* `/dump `: View the last messages (all if is omitted) * `/memory`: Print the current contents of agent memory * `/pop`: Undo the last message in the conversation +* `/pop `: Undo the last messages in the conversation. It defaults to 3, which usually is one turn around in the conversation +* `/retry`: Pops the last answer and tries to get another one +* `/rethink `: Will replace the inner dialog of the last assistant message with the to help shaping the conversation +* `/rewrite`: Will replace the last assistant answer with the given text to correct or force the answer * `/heartbeat`: Send a heartbeat system message to the agent * `/memorywarning`: Send a memory warning system message to the agent @@ -168,10 +173,6 @@ Note: your Azure endpoint must support functions or you will get an error. See h #### Custom Endpoints To use custom endpoints, run `export OPENAI_API_BASE=` and then re-run `memgpt configure` to set the custom endpoint as the default endpoint. - - - -

Deprecated API

@@ -275,39 +276,6 @@ You can run MemGPT with local LLMs too. See [instructions here](/memgpt/local_ll ```
- -### Interactive CLI commands - -These are the commands for the CLI, **not the Discord bot**! The Discord bot has separate commands you can see in Discord by typing `/`. - -While using MemGPT via the CLI (not Discord!) you can run various commands: - -```text -// - toggle multiline input mode -/exit - exit the CLI -/save - save a checkpoint of the current agent/conversation state -/load - load a saved checkpoint -/dump - view the last messages (all if is omitted) -/memory - print the current contents of agent memory -/pop - undo the last messages in the conversation. It defaults to 3, which usually is one turn around in the conversation -/retry - pops the last answer and tries to get another one -/rethink - will replace the inner dialog of the last assistant message with the to help shaping the conversation -/rewrite - will replace the last assistant answer with the given text to correct or force the answer -/heartbeat - send a heartbeat system message to the agent -/memorywarning - send a memory warning system message to the agent -``` ## Example applications

Use MemGPT to talk to your Database!

diff --git a/docs/quickstart.md b/docs/quickstart.md index 890e9c0088..6ed2212ed2 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -35,6 +35,19 @@ In this example we use the OpenAI API, but you can run MemGPT with other backend * [Running MemGPT on OpenAI Azure and custom OpenAI endpoints](endpoints.md) * [Running MemGPT with your own LLMs (Llama 2, Mistral 7B, etc.)](local_llm.md) +### Command-line arguments + +The `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 [gpt-4, gpt-3.5]. +* `--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) + ### In-chat commands You can run the following commands during an active chat session in the MemGPT CLI prompt: @@ -43,8 +56,13 @@ You can run the following commands during an active chat session in the MemGPT C * `/attach`: Attach a loaded data source to the agent * `/save`: Save a checkpoint of the current agent/conversation state * `/dump`: View the current message log (see the contents of main context) +* `/dump `: View the last messages (all if is omitted) * `/memory`: Print the current contents of agent memory * `/pop`: Undo the last message in the conversation +* `/pop `: Undo the last messages in the conversation. It defaults to 3, which usually is one turn around in the conversation +* `/retry`: Pops the last answer and tries to get another one +* `/rethink `: Will replace the inner dialog of the last assistant message with the to help shaping the conversation +* `/rewrite`: Will replace the last assistant answer with the given text to correct or force the answer * `/heartbeat`: Send a heartbeat system message to the agent * `/memorywarning`: Send a memory warning system message to the agent