Skip to content

Commit dd08d56

Browse files
committed
Update service account usage instructions
1 parent 6c9d417 commit dd08d56

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

.agents/PINECONE-cli.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Choose one method:
3434

3535
### Option 1: User Login (Recommended for Development)
3636

37+
Only use if you can confirm the user has an interactive terminal with browser access
38+
3739
```bash
3840
pc auth login
3941
```
@@ -46,14 +48,10 @@ pc auth login
4648
- **Use Option 2 (API Key)** or **Option 3 (Service Account)** instead
4749
- These methods work in all environments and are better suited for automation
4850

49-
**When to use each method:**
50-
51-
- **User Login (`pc auth login`)**: Only use if you can confirm the user has an interactive terminal with browser access
52-
- **API Key**: Use for most automated scenarios, CI/CD, or when browser access is unavailable
53-
- **Service Account**: Use for production automation and service-to-service authentication
54-
5551
### Option 2: API Key
5652

53+
Use for most automated scenarios, CI/CD, or when browser access is unavailable. Scoped to a specific project.
54+
5755
```bash
5856
pc auth configure --api-key your-api-key
5957
```
@@ -62,11 +60,18 @@ pc auth configure --api-key your-api-key
6260

6361
### Option 3: Service Account
6462

63+
Use when you need access to multiple projects within an organization. Scoped at the organization level (see details below).
64+
6565
```bash
6666
pc auth configure --client-id your-client-id --client-secret your-client-secret
6767
```
6868

69-
**Full CLI reference:** [https://docs.pinecone.io/reference/cli/command-reference](https://docs.pinecone.io/reference/cli/command-reference)
69+
**Key difference from API Key**: Service accounts are scoped at the **organization level** (not project level), providing access to **all projects within the organization**. This makes them ideal for:
70+
71+
- Managing multiple projects across an organization
72+
- Cross-project automation and deployment pipelines
73+
- Service-to-service authentication where access to multiple projects is needed
74+
- Centralized authentication for organization-wide operations
7075

7176
## Index Management
7277

@@ -189,13 +194,13 @@ pc index create -n my-app-prod -m cosine -c aws -r us-east-1 \
189194
190195
### Common Issues
191196

192-
| Issue | Solution |
193-
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
194-
| `pc: command not found` | Install CLI: `brew tap pinecone-io/tap && brew install pinecone-io/tap/pinecone` |
195-
| `Unknown command` or unrecognized command | Check CLI version with `pc version`. If outdated, update: `brew update && brew upgrade pinecone` (macOS) or download latest from [GitHub Releases](https://github.com/pinecone-io/cli/releases) |
196-
| `Authentication failed` | Run `pc auth login` or set an API key or service account |
197-
| `Index already exists` | Use different name or delete existing: `pc index delete --name <name>` |
198-
| `Permission denied` | Check API key permissions or organization access |
197+
| Issue | Solution |
198+
| ----------------------------------------- | -------------------------------------------------------------------------------- |
199+
| `pc: command not found` | Install CLI: `brew tap pinecone-io/tap && brew install pinecone-io/tap/pinecone` |
200+
| `Unknown command` or unrecognized command | See troubleshooting steps above (check version, update if needed) |
201+
| `Authentication failed` | Run `pc auth login` or set an API key or service account |
202+
| `Index already exists` | Use different name or delete existing: `pc index delete --name <name>` |
203+
| `Permission denied` | Check API key permissions or organization access |
199204

200205
### Verification Commands
201206

0 commit comments

Comments
 (0)