pyform-setup

pyform Setup

Help the user configure their pyform API Key by creating or updating a project-local .env file.

Flow

1. Check if a key was provided

If the user included a key (a string starting with pyf_) in their message, extract it and skip to step 3.

If no key was provided, respond with:

To connect with your pyform account you need an API Key:

1. Open your pyform dashboard → Settings → API Keys
2. Click "New Key" and copy the generated key
3. Paste it here or run: /pyform-setup pyf_your_key_here

You only need to do this once per project.

Then stop and wait for the user to provide the key.

2. Validate the key

Confirm the key starts with pyf_ and is at least 20 characters long. If invalid, inform the user:

That doesn't look like a valid pyform API Key. Keys start with pyf_ and are at least 20 characters long. Check your dashboard at Settings → API Keys.

3. Save to .env

# Check if .env exists and already has PYFORM_API_KEY
if [ -f .env ] && grep -q '^PYFORM_API_KEY=' .env; then
  # Update existing key in place
  sed -i 's/^PYFORM_API_KEY=.*/PYFORM_API_KEY="THE_KEY"/' .env
else
  # Append new key
  echo 'PYFORM_API_KEY="THE_KEY"' >> .env
fi

Replace THE_KEY with the actual key value.

4. Verify .gitignore

Check if .gitignore exists and contains .env. If not, warn:

Important: Make sure .env is in your .gitignore to avoid committing secrets.

echo '.env' >> .gitignore

5. Confirm success

Your pyform API Key has been saved. You can now create forms with /generate-form.