Skip to content

Commit 5dbec76

Browse files
committed
Install instructions for Gemini CLI
1 parent 4a133ae commit 5dbec76

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

README.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,31 @@ Add-Content -Path CLAUDE.md -Value (Get-Content AGENTS-pinecone-snippet.md)
108108
Remove-Item AGENTS-pinecone-snippet.md
109109
```
110110

111+
### Gemini CLI
112+
113+
Gemini CLI uses `GEMINI.md` context files instead of `AGENTS.md`. These files are loaded hierarchically from your project root and provide instructions to the AI assistant.
114+
115+
**Linux/macOS (Bash/Zsh):**
116+
117+
```bash
118+
curl -L -o agents.zip https://github.com/pinecone-io/pinecone-agents-ref/releases/latest/download/agents.zip
119+
unzip agents.zip && rm agents.zip
120+
touch GEMINI.md && cat AGENTS-pinecone-snippet.md >> GEMINI.md && rm AGENTS-pinecone-snippet.md
121+
```
122+
123+
**Windows (PowerShell):**
124+
125+
```powershell
126+
Invoke-WebRequest -Uri https://github.com/pinecone-io/pinecone-agents-ref/releases/latest/download/agents.zip -OutFile agents.zip
127+
Expand-Archive -Path agents.zip -DestinationPath . -Force
128+
Remove-Item agents.zip
129+
if (-not (Test-Path GEMINI.md)) { New-Item -Path GEMINI.md -ItemType File }
130+
Add-Content -Path GEMINI.md -Value (Get-Content AGENTS-pinecone-snippet.md)
131+
Remove-Item AGENTS-pinecone-snippet.md
132+
```
133+
134+
**Note:** Gemini CLI automatically loads `GEMINI.md` files from your project root. The context file contains instructions that tell the AI to read the `.agents/PINECONE.md` file when needed. You can also place context files in subdirectories for more specific instructions. Use `/memory refresh` in Gemini CLI to reload context files if needed.
135+
111136
That's it! Your project now has the `.agents/` folder with all Pinecone documentation and your configuration file has been updated.
112137

113138
### Important: Allow Re-indexing
@@ -117,7 +142,9 @@ Many coding assistants need to re-index your codebase to recognize the new `.age
117142
- **Wait a few moments** for automatic re-indexing to complete, or
118143
- **Manually trigger a re-index** (if your assistant provides this option)
119144

120-
If you start using Pinecone features immediately after installation, your assistant may not yet have access to the Pinecone documentation. Once re-indexing is complete, your assistant will automatically reference the `.agents/PINECONE.md` files when you ask questions about Pinecone.
145+
**For Gemini CLI users:** After installation, use the `/memory refresh` command to reload context files. This ensures the CLI picks up your new `GEMINI.md` file and the `.agents/` folder.
146+
147+
If you start using Pinecone features immediately after installation, your assistant may not yet have access to the Pinecone documentation. Once re-indexing is complete (or after running `/memory refresh` in Gemini CLI), your assistant will automatically reference the `.agents/PINECONE.md` files when you ask questions about Pinecone.
121148

122149
### Verify Installation
123150

@@ -135,21 +162,23 @@ your-project/
135162
│ ├── PINECONE-java.md # Java SDK guide
136163
│ └── PINECONE-troubleshooting.md # Troubleshooting guide
137164
└── AGENTS.md # Your project's agent guide (with Pinecone section)
165+
# or CLAUDE.md for Claude Code
166+
# or GEMINI.md for Gemini CLI
138167
139168
```
140169

141170
### Customizing the Integration
142171

143-
The third command appends `AGENTS-pinecone-snippet.md` to your `AGENTS.md`. If you already have an `AGENTS.md` file and want more control over where the Pinecone section is placed:
172+
The installation commands append the appropriate snippet file to your configuration file. If you already have a configuration file and want more control over where the Pinecone section is placed:
144173

145174
1. Extract the archive: `unzip agents.zip && rm agents.zip`
146175
2. Open `AGENTS-pinecone-snippet.md` and copy the "Pinecone (Vector Database)" section
147-
3. Manually add it to your `AGENTS.md` where you prefer
148-
4. Remove the snippet file: `rm AGENTS-pinecone-snippet.md`
176+
3. Manually add it to your configuration file (`AGENTS.md`, `CLAUDE.md`, or `GEMINI.md`) where you prefer
177+
4. Remove the snippet file
149178

150179
## Updating
151180

152-
To update to a newer version, simply download the latest release and extract the archive. Your configuration file (`AGENTS.md` or `CLAUDE.md` if using Claude Code) typically doesn't need changes unless the structure changes.
181+
To update to a newer version, simply download the latest release and extract the archive. Your configuration file (`AGENTS.md`, `CLAUDE.md`, or `GEMINI.md`) typically doesn't need changes unless the structure changes.
153182

154183
**Linux/macOS (Bash/Zsh):**
155184

@@ -203,7 +232,7 @@ The workflow triggers automatically on tag push (`push: tags: v*`) and:
203232
- If no release exists → creates a new release automatically
204233
3. Packages the following files:
205234
- All files from `.agents/` folder (8 Pinecone documentation files)
206-
- `AGENTS-pinecone-snippet.md` file
235+
- `AGENTS-pinecone-snippet.md` file (works for all assistants including Gemini CLI)
207236
4. Creates archives with the structure:
208237
```
209238
archive/

0 commit comments

Comments
 (0)