summaryrefslogtreecommitdiff
path: root/docs/tools/memory.md
diff options
context:
space:
mode:
authorJenna Inouye <[email protected]>2025-06-24 15:31:58 -0700
committerGitHub <[email protected]>2025-06-24 22:31:58 +0000
commit4bf18da2b08e145d2f4c91f2331347bf8568aed3 (patch)
tree4833d2232d19943171f64e27ace895b9fbf5cf27 /docs/tools/memory.md
parent8bd5645dd487574763325fb44e15feb97771607c (diff)
Documents: Add docs tools pages (#1397)
Diffstat (limited to 'docs/tools/memory.md')
-rw-r--r--docs/tools/memory.md63
1 files changed, 41 insertions, 22 deletions
diff --git a/docs/tools/memory.md b/docs/tools/memory.md
index b134b948..fa2dac57 100644
--- a/docs/tools/memory.md
+++ b/docs/tools/memory.md
@@ -1,25 +1,44 @@
-# Memory Tool
+# Memory Tool (`save_memory`)
-This document provides details on the `save_memory` tool.
+This document describes the `save_memory` tool for the Gemini CLI.
-## `save_memory`
+## Description
-- **Purpose:** Saves a specific piece of information or fact to your long-term memory. This allows the CLI to remember key details across sessions, providing more personalized and effective assistance.
-- **Arguments:**
- - `fact` (string, required): The specific fact or piece of information to remember. This should be a clear, self-contained statement.
-- **Behavior:**
- - The tool appends the provided `fact` to a special `GEMINI.md` file located in the user's home directory (`~/.gemini/GEMINI.md`). This file can be configured to have a different name.
- - The facts are stored under a `## Gemini Added Memories` section.
- - This file is loaded as context in subsequent sessions, allowing the CLI to recall the saved information.
-- **Examples:**
- - Remembering a user preference:
- ```
- save_memory(fact="My preferred programming language is Python.")
- ```
- - Storing a project-specific detail:
- ```
- save_memory(fact="The project I'm currently working on is called 'gemini-cli'.")
- ```
-- **Important Notes:**
- - This tool should be used for concise, important facts. It is not intended for storing large amounts of data or conversational history.
- - The memory file is a plain text Markdown file, so you can view and edit it manually if needed.
+Use `save_memory` to save and recall information across your Gemini CLI sessions. With `save_memory`, you can direct the CLI to remember key details across sessions, providing personalized and directed assistance.
+
+### Arguments
+
+`save_memory` takes one argument:
+
+- `fact` (string, required): The specific fact or piece of information to remember. This should be a clear, self-contained statement written in natural language.
+
+## How to use `save_memory` with the Gemini CLI
+
+The tool appends the provided `fact` to a special `GEMINI.md` file located in the user's home directory (`~/.gemini/GEMINI.md`). This file can be configured to have a different name.
+
+Once added, the facts are stored under a `## Gemini Added Memories` section. This file is loaded as context in subsequent sessions, allowing the CLI to recall the saved information.
+
+Usage:
+
+```
+save_memory(fact="Your fact here.")
+```
+
+### `save_memory` examples
+
+Remember a user preference:
+
+```
+save_memory(fact="My preferred programming language is Python.")
+```
+
+Store a project-specific detail:
+
+```
+save_memory(fact="The project I'm currently working on is called 'gemini-cli'.")
+```
+
+## Important notes
+
+- **General usage:** This tool should be used for concise, important facts. It is not intended for storing large amounts of data or conversational history.
+- **Memory file:** The memory file is a plain text Markdown file, so you can view and edit it manually if needed.