cli

README

Pinecone CLI

⚠️ Warning: This SDK is still in an alpha state. While it is mostly built out and functional, it may undergo changes as we continue to improve the UX. Please try it out and give us your feedback, but be aware that updates may introduce breaking changes.

pc is Pinecone on the command line.

This CLI is still in an alpha state and does not support every operation available through our REST apis. Please try it out and give us your feedback, but also be prepared to upgrade as we continue building out the feature set and improving the UX.

Installing

Via Homebrew (Mac)

The most convenient way to install this is via Homebrew

brew tap pinecone-io/tap
brew install pinecone-io/tap/pinecone

pc --help

If you have previously installed and would like to upgrade to the latest version, run

brew update
brew upgrade pinecone

Download artifacts from release page (Linux, Windows)

We have pre-built binaries for many platforms available on the Releases page.

Build from source

To learn about the steps involved in building from source, see CONTRIBUTING

Usage

In order to use the Pinecone CLI you will need to authenticate with Pinecone services. This can be done either with an API key, or using the pc login flow to authenticate with a Pinecone account via your browser.

pc --help

# If you have PINECONE_API_KEY set in your environment you can begin working with the CLI
pc index list

# To set an API key manually, you can use the config command
pc config set-api-key "YOUR_API_KEY"

# Additionally, you can authenticate through the browser using the login command
pc login

# To clear your current login state or configured API key, you can use the logout command
pc logout

If an API key is configured along with using pc login, the CLI will default to using the API key over the authentication token.

If there has been an API key set using pc config set-api-key, and PINECONE_API_KEY is also present in the environment, the API set in the CLI config will be used over the environment key.

Managing indexes

# Learn about supported index operations
pc index --help

# Create serverless indexes.
pc index create-serverless --help
pc index create-serverless --name example-index --dimension 1536 --metric cosine --cloud aws --region us-west-2
pc index create-serverless --name="example-index" --dimension=1536 --metric="cosine" --cloud="aws" --region="us-west-2"
pc index create-serverless -n example-index -d 1536 -m cosine -c aws -r us-west-2

# Describe index
pc index describe --name "example-index"
pc index describe --name "example-index" --json

# List indexes
pc index list
pc index list --json

# Delete index
pc index delete --name "example-index"