You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-12Lines changed: 19 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# Pinecone Agent Reference
2
2
3
-
This repository contains specialized agent instructions for the Pinecone vector database, designed to be integrated into your project's `AGENTS.md` file for use with AI coding assistants.
3
+
This repository contains specialized agent instructions for the Pinecone vector database, designed to be integrated into your AI coding assistant's configuration file.
4
+
5
+
[AGENTS.md](https://agents.md/) is an open format used by over 20k open-source projects and is supported by most coding assistants including Cursor, Aider, GitHub Copilot, and many others.
4
6
5
7
## What's Included
6
8
@@ -16,20 +18,27 @@ This repository provides comprehensive Pinecone documentation organized into the
16
18
17
19
## Quick Start
18
20
19
-
Install with three simple commands:
21
+
The general process is to download the latest release, extract the archive, and add the Pinecone section to your assistant's configuration file.
22
+
23
+
### Most Assistants (Cursor, Aider, GitHub Copilot, etc.)
That's it! Your project now has the `.agents/` folder with all Pinecone documentation and your configuration file has been updated.
33
42
34
43
### Verify Installation
35
44
@@ -60,13 +69,11 @@ The third command appends `AGENTS-pinecone-snippet.md` to your `AGENTS.md`. If y
60
69
61
70
## Updating
62
71
63
-
To update to a newer version:
72
+
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.
0 commit comments