pc is Pinecone on the command line. See the Pinecone CLI PRD

1. Install golang if you do not have it already

2. Install just if you'd like to run the formulas in the justfile.

3. Install goreleaser

brew install --cask goreleaser/tap/goreleaser

4. Clone the repo, and build the CLI

git clone [email protected]:pinecone-io/cli.git
goreleaser build --single-target --snapshot --clean

For manual testing in development, you can run commands like this

./dist/pc_darwin_arm64/pc login
./dist/pc_darwin_arm64/pc index list
# etc

# See help
./dist/pc_darwin_arm64/pc --help

# Set authorization credentials - set an API key directly, or log in via the OAuth flow
./dist/pc_darwin_arm64/pc config set-api-key
./dist/pc_darwin_arm64/pc login

# Check currently configured API key
./dist/pc_darwin_arm64/pc config get-api-key

# Do index operations
./dist/pc_darwin_arm64/pc index --help

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

# Describe index
./dist/pc_darwin_arm64/pc index describe --name "example-index"
./dist/pc_darwin_arm64/pc index describe --name "example-index" --json

# List indexes
./dist/pc_darwin_arm64/pc index list
./dist/pc_darwin_arm64/pc index list --json

# Delete index
./dist/pc_darwin_arm64/pc index delete --name "example-index"

Some facts that could be useful:

• Configuration files are stored in ~/.config/pinecone.
• You can enable debug output with the PINECONE_LOG_LEVEL=DEBUG env var.
• Are you pointed at the correct environment? The current value of the environment setting (i.e. prod or staging) is controlled through pc config set-environment staging is not clearly surfaced through the printed output. If things aren't working as you expect, you might be pointed in the wrong place. See cat ~/.config/pinecone/config.yaml to confirm.

Please fork this repo and make a PR with your changes. Run gofmt and goimports on all proposed code changes. Code that does not adhere to these formatters will not be merged.

To make a new release, you simply tag a commit with a version and push it. The heavy lifting all happens in CI.

Something along these lines:

# Pull and ensure you have no uncomitted changes
git checkout main
git pull
git status

# Ensure the tip of main actually builds
gorelaser build --clean --snapshot

# Look at what version tags have previously been used
git tag --list

# Based on the previous history and the nature of the
# new stuff in the code you are releasing, choose a
# tag that makes sense for the next version.
#
# The tag must start with "v" to trigger the CI stuff.
git tag v0.0.40

# Push the tag to github
git push --tags

From there, everything happens in this publish workflow which is using goreleaser to handle the process of building binaries for different platforms, packing them into archives, publishing those artifacts on github, and updating our homebrew formula so those updates are easily installable on mac. In the future this will probably expand to cover more forms of distribution. If anything breaks down in this process, the .goreleaser.yaml file is probably where your attention will be needed but so far it has been very reliable.

Within a few minutes of pushing tags, you should see:

• A new update to the Releases page with built artifacts attached. If you want to be fancy, you can edit the text there to give a more narrative overview of what is in the release. But for these early iterations we're just pushing and shipping without a lot of ceremony.
• Updates to to the Homebrew tap should happen automatically

To consume the update from Homebrew (assuming they have previously installed it from homebrew), users should run

brew update
brew upgrade pinecone