---
name: pp-pinecone
description: "Every Pinecone API feature, plus local sync, snapshot history, and text-first search no other Pinecone tool has. Trigger phrases: `query my pinecone index`, `upsert vectors into pinecone`, `search pinecone embeddings`, `check pinecone index health`, `what changed in my pinecone index`, `use pinecone`, `run pinecone`."
author: "Som Samantray"
license: "Apache-2.0"
argument-hint: "<command> [args] | install cli|mcp"
allowed-tools: "Read Bash"
metadata:
  openclaw:
    requires:
      bins:
        - pinecone-pp-cli
    install:
      - kind: go
        bins: [pinecone-pp-cli]
        module: github.com/mvanhorn/printing-press-library/library/ai/pinecone/cmd/pinecone-pp-cli
---

# Pinecone — Printing Press CLI

## Prerequisites: Install the CLI

This skill drives the `pinecone-pp-cli` binary. **You must verify the CLI is installed before invoking any command from this skill.** If it is missing, install it first:

1. Install via the Printing Press installer. It defaults binaries to `$HOME/.local/bin` on macOS/Linux and `%LOCALAPPDATA%\Programs\PrintingPress\bin` on Windows:
   ```bash
   npx -y @mvanhorn/printing-press-library install pinecone --cli-only
   ```
2. Verify: `pinecone-pp-cli --version`
3. Ensure the reported install directory is on `$PATH` for the agent/runtime that will invoke this skill.

If the `npx` install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.6 or newer). This installs into `$GOPATH/bin` (default `$HOME/go/bin`), so add that directory to `$PATH` instead:

```bash
go install github.com/mvanhorn/printing-press-library/library/ai/pinecone/cmd/pinecone-pp-cli@latest
```

If `--version` reports "command not found" after install, the runtime cannot see the binary directory on `$PATH`. Do not proceed with skill commands until verification succeeds.

The Pinecone CLI manages indexes, vectors, namespaces, backups, imports, inference, and admin — then goes further: sync index and record metadata into a local SQLite database for offline search, capture snapshot history to diff and project growth, and search by natural language without touching vectors. Agent-native --json/--select/csv output and typed exit codes make it scriptable in CI.

## When to Use This CLI

Use this CLI when you manage Pinecone indexes and vectors from a terminal or agent: create and scale indexes, ingest and query vectors, run semantic search over text, audit backup coverage, and track index growth over time. It is the right tool for RAG pipelines, embedding workflows, and index fleet administration.

## Anti-triggers

Do not use this CLI for:
- Do not use this CLI for large bulk imports (10M+ records) — use object-storage import via the Pinecone console or SDK
- Do not use this CLI for real-time streaming ingestion at high throughput — use the Python/Go SDK with gRPC
- Do not use this CLI to manage non-Pinecone vector databases
- Do not use this CLI for integrated-embedding text search on indexes that do not have integrated inference configured

## Unique Capabilities

These capabilities aren't available in any other tool for this API.

### Search that works the way humans think
- **`text-query`** — Search a dense index with a natural-language query — embeds the text via Pinecone Inference, then queries the index — without managing vectors yourself.

  _Use when an agent needs semantic retrieval from an index but only has a text query, not a precomputed vector._

  ```bash
  pinecone-pp-cli text-query travel-chat-embeddings --text "visa on arrival for thailand" --top-k 5 --json
  ```
- **`cascade`** — Run one semantic query across multiple indexes and merge the ranked results (deduped by vector ID, best score wins) into a single agent-ready list.

  _Use when an agent needs to search across several indexes (e.g. prod vs staging, multiple tenants) in one shot._

  ```bash
  pinecone-pp-cli cascade --indexes travel-chat-embeddings,travel-chat-embeddings-v2 --text "kyoto itinerary" --top-k 3 --json
  ```

### Local state that compounds
- **`snapshot`** — Capture a point-in-time state of any index (per-namespace vector counts, dimension, metric, host) into local SQLite, then diff against prior snapshots to see exactly what changed.

  _Use when an agent needs to answer "what changed in this index since last week?" for drift, growth, or incident review._

  ```bash
  pinecone-pp-cli snapshot travel-chat-embeddings --note weekly
  ```
- **`usage`** — Compute vector-count growth and per-namespace distribution shifts from snapshot history, with a projection to a future horizon.

  _Use when an agent needs to forecast index growth or spot a namespace ballooning before it hits quota._

  ```bash
  pinecone-pp-cli usage --index travel-chat-embeddings --since 30d --json
  ```
- **`coverage`** — Join backups, backup schedules, and restore jobs into a per-index protection matrix showing which indexes are backed up, scheduled, and restorable.

  _Use when an agent audits disaster-recovery posture across an index fleet._

  ```bash
  pinecone-pp-cli coverage --json
  ```

### Memory lifecycle
- **`prune`** — Find vectors whose local metadata timestamps are older than a threshold and delete them in batches — dry-run by default, with --apply to commit.

  _Use when an agent maintains a long-lived memory store and needs to expire stale chunks without a full resync._

  ```bash
  pinecone-pp-cli prune travel-chat-embeddings --namespace __default__ --older-than 90d --apply
  ```
- **`check-vectors`** — Validate a vectors JSON file against the index schema — dimension, duplicate/empty IDs, sparse/dense shape — before you upsert and burn write units on a rejected batch.

  _Use when an agent ingests data and wants to catch dimension or ID errors before a costly rejected batch._

  ```bash
  pinecone-pp-cli check-vectors --index travel-chat-embeddings --file vectors.json --json
  ```

## Command Reference

**admin** — Manage admin

- `pinecone-pp-cli admin create-api-key` — Create an API key for a project to authenticate Data Plane and Control Plane requests.
- `pinecone-pp-cli admin create-invite` — Invite a user to the organization by email and grant their initial role bindings.
- `pinecone-pp-cli admin create-project` — Create a new project.
- `pinecone-pp-cli admin create-role-binding` — Grant a role to a principal at an organization or project scope.
- `pinecone-pp-cli admin create-service-account` — Create a service account with optional initial role bindings; the client secret is returned only once.
- `pinecone-pp-cli admin delete-api-key` — Delete an API key from a project.
- `pinecone-pp-cli admin delete-invite` — Delete a pending or expired invite and its role bindings; to remove an accepted user, delete the user instead.
- `pinecone-pp-cli admin delete-organization` — Delete an organization and all its configuration; delete all its projects first.
- `pinecone-pp-cli admin delete-project` — Delete a project and all its configuration; delete its indexes, assistants, backups, and collections first.
- `pinecone-pp-cli admin delete-role-binding` — Delete a role binding; permissions are revoked when the deletion completes.
- `pinecone-pp-cli admin delete-service-account` — Delete a service account and its role bindings; tokens it minted are revoked within a few seconds.
- `pinecone-pp-cli admin delete-user` — Remove a user from the organization and revoke their role bindings; their Pinecone account is not deleted.
- `pinecone-pp-cli admin fetch-api-key` — Get an API key's details, excluding its secret.
- `pinecone-pp-cli admin fetch-invite` — Get an invite in the caller's organization by ID.
- `pinecone-pp-cli admin fetch-organization` — Get an organization's details.
- `pinecone-pp-cli admin fetch-project` — Get a project's details.
- `pinecone-pp-cli admin fetch-role-binding` — Get a role binding in the caller's organization by ID.
- `pinecone-pp-cli admin fetch-service-account` — Get a service account by ID; the client secret is returned only from create and rotate-secret requests.
- `pinecone-pp-cli admin fetch-user` — Get a user in the caller's organization by ID.
- `pinecone-pp-cli admin list-invites` — List pending and expired invites in the caller's organization.
- `pinecone-pp-cli admin list-organizations` — List all organizations associated with an account.
- `pinecone-pp-cli admin list-project-api-keys` — List all API keys in a project.
- `pinecone-pp-cli admin list-projects` — List all projects in an organization.
- `pinecone-pp-cli admin list-role-bindings` — List role bindings in the caller's organization, optionally filtered by principal, resource, and role.
- `pinecone-pp-cli admin list-service-accounts` — List service accounts in the caller's organization.
- `pinecone-pp-cli admin list-users` — List users in the caller's organization, optionally filtered by email address.
- `pinecone-pp-cli admin resend-invite` — Resend the invite email and extend its expiration to 7 days from now; limited to 100 emails per hour per organization.
- `pinecone-pp-cli admin rotate-service-account-secret` — Rotate a service account's OAuth client secret
- `pinecone-pp-cli admin update-api-key` — Update an API key's name and roles.
- `pinecone-pp-cli admin update-organization` — Update an organization's name.
- `pinecone-pp-cli admin update-project` — Update a project's name, maximum number of Pods, or customer-managed encryption key (CMEK).
- `pinecone-pp-cli admin update-service-account` — Update a service account's name; role bindings are managed through the role-binding endpoints.

**assistants** — Manage assistants

- `pinecone-pp-cli assistants create` — Create an assistant.
- `pinecone-pp-cli assistants delete` — Delete an existing assistant. For guidance and examples, see [Manage assistants](https://docs.pinecone.
- `pinecone-pp-cli assistants get` — Get the status of an assistant. For guidance and examples, see [Manage assistants](https://docs.pinecone.
- `pinecone-pp-cli assistants list` — List of all assistants in a project. For guidance and examples, see [Manage assistants](https://docs.pinecone.
- `pinecone-pp-cli assistants update` — Update an existing assistant. You can modify the assistant's instructions.

**backup-schedules** — Manage backup schedules

- `pinecone-pp-cli backup-schedules delete` — Permanently remove a backup schedule.
- `pinecone-pp-cli backup-schedules describe` — Get a single backup schedule by ID.
- `pinecone-pp-cli backup-schedules update` — Update frequency, retention, or enabled state for a backup schedule.

**backups** — Manage backups

- `pinecone-pp-cli backups delete` — Delete a backup.
- `pinecone-pp-cli backups describe` — Get a description of a backup.
- `pinecone-pp-cli backups list-project` — List backups for all indexes in a project

**bulk** — Manage bulk

- `pinecone-pp-cli bulk cancel-import` — Cancel an import operation if it is not yet finished. It has no effect if the operation is already finished.
- `pinecone-pp-cli bulk describe-import` — Return details of a specific import operation. For guidance and examples, see [Import data](https://docs.pinecone.
- `pinecone-pp-cli bulk list-imports` — List all recent and ongoing import operations. By default, `list_imports` returns up to 100 imports per page.
- `pinecone-pp-cli bulk start-import` — Start an asynchronous import of vectors from object storage into an index.

**chat** — Manage chat

- `pinecone-pp-cli chat <assistant_name>` — Chat with an assistant and get back citations in structured form.

**collections** — Manage collections

- `pinecone-pp-cli collections create` — Create a Pinecone collection. Serverless indexes do not support collections.
- `pinecone-pp-cli collections delete` — Delete an existing collection. Serverless indexes do not support collections.
- `pinecone-pp-cli collections describe` — Get a description of a collection. Serverless indexes do not support collections.
- `pinecone-pp-cli collections list` — List all collections in a project. Serverless indexes do not support collections.

**describe-index-stats** — Manage describe index stats

- `pinecone-pp-cli describe-index-stats` — Return statistics about the contents of an index, including the vector count per namespace, the number of dimensions

**embed** — Manage embed

- `pinecone-pp-cli embed` — Generate vector embeddings for input data. This endpoint uses Pinecone's [hosted embedding models](https://docs.

**files** — Manage files

- `pinecone-pp-cli files delete` — [Delete an uploaded file](https://docs.pinecone.io/guides/assistant/manage-files#delete-a-file) from an assistant.
- `pinecone-pp-cli files describe` — [Get the current status and metadata of a file](https://docs.pinecone.
- `pinecone-pp-cli files list` — List all files in an assistant, with an option to filter files with metadata.
- `pinecone-pp-cli files upload` — Upload a file to the specified assistant. An identifier will be generated.
- `pinecone-pp-cli files upsert` — Create or replace a file in the specified assistant.

**indexes** — Manage indexes

- `pinecone-pp-cli indexes configure-index` — Configure an existing index. For guidance and examples, see [Manage indexes](https://docs.pinecone.
- `pinecone-pp-cli indexes create-index` — Create a Pinecone index.
- `pinecone-pp-cli indexes create-index-for-model` — Create an index with integrated embedding.
- `pinecone-pp-cli indexes delete-index` — Delete an existing index.
- `pinecone-pp-cli indexes describe-index` — Get a description of an index.
- `pinecone-pp-cli indexes list` — List all indexes in a project.

**metrics** — Endpoints for accessing database metrics.

- `pinecone-pp-cli metrics <project_id>` — Get endpoints for Prometheus scraping.

**models** — Manage models

- `pinecone-pp-cli models get` — Get a description of a model hosted by Pinecone.
- `pinecone-pp-cli models list` — List the embedding and reranking models hosted by Pinecone.

**namespaces** — Manage namespaces

- `pinecone-pp-cli namespaces create` — Create a namespace in a serverless index. For guidance and examples, see [Manage namespaces](https://docs.pinecone.
- `pinecone-pp-cli namespaces delete` — Delete a namespace from a serverless index.
- `pinecone-pp-cli namespaces describe` — Describe a namespace in a serverless index, including the total number of vectors in the namespace.
- `pinecone-pp-cli namespaces list-operation` — List all namespaces in a serverless index.

**oauth** — Authentication using the OAuth2 protocol.

- `pinecone-pp-cli oauth` — Obtain an access token for a service account using the OAuth2 client credentials flow.

**operations** — Manage operations

- `pinecone-pp-cli operations describe` — Get the status of an operation.
- `pinecone-pp-cli operations list` — List all operations for an assistant.

**query** — Manage query

- `pinecone-pp-cli query` — Search a namespace using a query vector.

**records** — Manage records

- `pinecone-pp-cli records search-namespace` — Search a namespace with a query text, query vector, or record ID and return the most similar records
- `pinecone-pp-cli records upsert-namespace` — Upsert text into a namespace.

**rerank** — Manage rerank

- `pinecone-pp-cli rerank` — Rerank results according to their relevance to a query. For guidance and examples, see [Rerank results](https://docs.

**restore-jobs** — Manage restore jobs

- `pinecone-pp-cli restore-jobs describe` — Get a description of a restore job.
- `pinecone-pp-cli restore-jobs list` — List all restore jobs for a project.

**vectors** — Manage vectors

- `pinecone-pp-cli vectors delete` — Delete records by id or by metadata from a single namespace. For guidance and examples, see [Delete data](https://docs.
- `pinecone-pp-cli vectors fetch` — Look up and return records by ID from a single namespace. The returned records include the vector data and/or metadata.
- `pinecone-pp-cli vectors fetch-by-metadata` — Look up and return records by metadata from a single namespace.
- `pinecone-pp-cli vectors list` — List the IDs of records in a single namespace of a serverless index.
- `pinecone-pp-cli vectors update` — Update records by ID or by metadata in a namespace.
- `pinecone-pp-cli vectors upsert` — Upsert records into a namespace.


### Finding the right command

When you know what you want to do but not which command does it, ask the CLI directly:

```bash
pinecone-pp-cli which "<capability in your own words>"
```

`which` resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code `0` means at least one match; exit code `2` means no confident match — fall back to `--help` or use a narrower query.

## Recipes

### Semantic search over chat history

```bash
pinecone-pp-cli text-query travel-chat-embeddings --text "what did the group decide about kyoto" --top-k 5 --select matches.id,matches.metadata.sender,matches.score
```

Ask a natural-language question and get scored, deduped hits with metadata — no embedding step

### Weekly index health snapshot

```bash
pinecone-pp-cli snapshot travel-chat-embeddings --note weekly && pinecone-pp-cli snapshot diff --index travel-chat-embeddings --since 7d
```

Record index state weekly, then see exactly what changed: vector counts, namespaces, config drift

### Stale memory pruning dry-run

```bash
pinecone-pp-cli prune travel-chat-embeddings --namespace __default__ --older-than 90d
```

Preview which vectors would be deleted by age before committing with --apply

### Cascade search across environments

```bash
pinecone-pp-cli cascade --indexes travel-chat-embeddings,travel-chat-embeddings-v2 --text "trip itinerary" --top-k 3 --json
```

Search prod and staging indexes in one call and get a single merged, deduped ranked list

### Validate before you upsert

```bash
pinecone-pp-cli check-vectors --index travel-chat-embeddings --file vectors.json --json
```

Catch dimension and ID errors in a batch before it burns write units on a rejected upsert

### Agent-ready index inventory

```bash
pinecone-pp-cli indexes list --json --select name,host,dimension,spec.serverless.region | jq '.results[] | {name, host, dimension, region: .spec.serverless.region}'
```

Narrow a large response with --select and pipe to jq for a compact inventory

## Auth Setup

Pinecone uses an API key sent as the `Api-Key` header, with the required `X-Pinecone-Api-Version` header set to the API version (2026-04). Set PINECONE_API_KEY=<key> or run `pinecone-pp-cli auth set-token`. Data-plane commands target the per-index host, which the CLI resolves automatically from `indexes describe-index` when you pass --index, or via PINECONE_INDEX_HOST.

Run `pinecone-pp-cli doctor` to verify setup.

## Agent Mode

Add `--agent` to any command. Expands to: `--json --compact --no-input --no-color --yes`.

- **Pipeable** — JSON on stdout, errors on stderr
- **Filterable** — `--select` keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:

  ```bash
  pinecone-pp-cli assistants list --x-pinecone-api-version example-value --agent --select created_at,host,instructions
  ```
- **Previewable** — `--dry-run` shows the request without sending
- **Offline-friendly** — sync/search commands can use the local SQLite store when available
- **Non-interactive** — never prompts, every input is a flag
- **Explicit retries** — use `--idempotent` only when an already-existing create should count as success, and use `--ignore-missing` only when a missing delete target should count as success

### Response envelope

Commands that read from the local store or the API wrap output in a provenance envelope:

```json
{
  "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
  "results": <data>
}
```

Parse `.results` for data and `.meta.source` to know whether it's live or local. A human-readable `N results (live)` summary is printed to stderr