Bug: Environment variable name mismatch (CLOUDKIT_KEY_FILE vs CLOUDKIT_PRIVATE_KEY_PATH)

[leogdion]

Problem

Documentation and code have mismatched environment variable names:

• README: Recommends CLOUDKIT_KEY_FILE
• Code: Reads CLOUDKIT_PRIVATE_KEY_PATH

Users following README hit "credentials are required" errors.

Proposed Solution

Align docs with code OR change code to match docs.

Files

• Examples/Bushel/README.md:160-206, 415-422
• Examples/Bushel/Sources/BushelImages/Commands/*.swift

References

• PR update from writing blog post and examples MistKit#129 CodeRabbit Review

[leogdion]

Status: 🐛 DOCUMENTATION BUG - Code is Correct, README is Wrong

The README.md uses the wrong environment variable name. The code correctly uses CLOUDKIT_PRIVATE_KEY_PATH, but the documentation incorrectly shows CLOUDKIT_KEY_FILE.

Current State

Documentation Issues:

• Examples/BushelCloud/README.md:188 uses: export CLOUDKIT_KEY_FILE="./path/to/private-key.pem" ❌
• Examples/BushelCloud/README.md:278 uses: export CLOUDKIT_KEY_FILE="./path/to/private-key.pem" ❌

Correct Usage (from code):

• Examples/BushelCloud/CLAUDE.md:23 uses: export CLOUDKIT_PRIVATE_KEY_PATH="$HOME/.cloudkit/bushel-private-key.pem" ✅
• Code in CloudKitConfiguration.swift:98 checks for: CLOUDKIT_PRIVATE_KEY_PATH ✅

Impact

Users following the README will hit "credentials are required" errors because they're setting the wrong environment variable name.

What Remains

Fix the environment variable name in two locations:

Line 188:

# Wrong
export CLOUDKIT_KEY_FILE="./path/to/private-key.pem"

# Correct
export CLOUDKIT_PRIVATE_KEY_PATH="./path/to/private-key.pem"

Line 278:

# Wrong
export CLOUDKIT_KEY_FILE="./path/to/private-key.pem"

# Correct
export CLOUDKIT_PRIVATE_KEY_PATH="./path/to/private-key.pem"

Environment Variables Supported

According to CloudKitConfiguration.swift:88-101, the code validates ONE of:

• CLOUDKIT_PRIVATE_KEY_PATH (file path to PEM file)
• CLOUDKIT_PRIVATE_KEY (raw PEM string)

Files to Fix

• Examples/BushelCloud/README.md:188
• Examples/BushelCloud/README.md:278

[leogdion]

Fixed in commit 026b4db. All instances of CLOUDKIT_KEY_FILE have been replaced with CLOUDKIT_PRIVATE_KEY_PATH to match the actual environment variable used in the code.

Changes:

• Line 188: First sync example
• Line 278: Environment variables usage example
• Line 488: Method 2 environment variables example
• Line 671: Troubleshooting example
• Line 672: Verify file exists command

The documentation now correctly shows the environment variable name that matches CloudKitConfiguration.swift:98.