Skip to content

Commit 2341abb

Browse files
committed
Update README for Claude Code users
1 parent f69d332 commit 2341abb

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Pinecone Agent Reference
22

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.
46

57
## What's Included
68

@@ -16,20 +18,27 @@ This repository provides comprehensive Pinecone documentation organized into the
1618

1719
## Quick Start
1820

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.)
2024

2125
```bash
22-
# 1. Download the latest release
2326
curl -L -o agents.zip https://github.com/pinecone-io/pinecone-agents-ref/releases/latest/download/agents.zip
24-
25-
# 2. Extract the archive
2627
unzip agents.zip && rm agents.zip
27-
28-
# 3. Add Pinecone section to AGENTS.md (creates it if it doesn't exist)
2928
touch AGENTS.md && cat AGENTS-pinecone-snippet.md >> AGENTS.md && rm AGENTS-pinecone-snippet.md
3029
```
3130

32-
That's it! Your project now has the `.agents/` folder with all Pinecone documentation and your `AGENTS.md` file has been updated.
31+
### Claude Code
32+
33+
Claude Code uses `CLAUDE.md` instead of `AGENTS.md`. :
34+
35+
```bash
36+
curl -L -o agents.zip https://github.com/pinecone-io/pinecone-agents-ref/releases/latest/download/agents.zip
37+
unzip agents.zip && rm agents.zip
38+
touch CLAUDE.md && cat AGENTS-pinecone-snippet.md >> CLAUDE.md && rm AGENTS-pinecone-snippet.md
39+
```
40+
41+
That's it! Your project now has the `.agents/` folder with all Pinecone documentation and your configuration file has been updated.
3342

3443
### Verify Installation
3544

@@ -60,13 +69,11 @@ The third command appends `AGENTS-pinecone-snippet.md` to your `AGENTS.md`. If y
6069

6170
## Updating
6271

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.
6473

6574
```bash
66-
# Download the latest version
6775
curl -L -o agents.zip https://github.com/pinecone-io/pinecone-agents-ref/releases/latest/download/agents.zip
68-
rm -rf .agents && unzip agents.zip && rm agents.zip
69-
# AGENTS.md typically doesn't need changes unless the structure changes
76+
rm -rf .agents/PINECONE* && unzip agents.zip && rm agents.zip
7077
```
7178

7279
## Usage

0 commit comments

Comments
 (0)