Skip to content

docs: Add troubleshooting for corrupted credentials file#591

Merged
muhsinking merged 2 commits intomainfrom
promptless/corrupted-config-troubleshooting
Mar 25, 2026
Merged

docs: Add troubleshooting for corrupted credentials file#591
muhsinking merged 2 commits intomainfrom
promptless/corrupted-config-troubleshooting

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Mar 24, 2026

Open this suggestion in Promptless to view citations and reasoning process

Adds a troubleshooting entry for corrupted credentials files. Documents the specific error message "~/.runpod/config.toml is corrupted and cannot be parsed" from Flash CLI, as well as the generic "No API key found" symptom. Provides the solution to delete the credentials file and re-authenticate with flash login.

Trigger Events

runpod/runpod-python PR #481: fix(config): handle corrupted config.toml in credential functions

Promptless Research (8 files, 1 GitHub PR)

  • Reviewed runpod/runpod-python#481
  • Viewed .long_term_context/product_knowledge/product_overview.md
  • Viewed .long_term_context/doc_workflow/client_instructions.md
  • Viewed sdks/python/overview.mdx
  • Viewed runpodctl/reference/runpodctl-config.mdx
  • Viewed flash/cli/login.mdx
  • Viewed flash/troubleshooting.mdx
  • Viewed serverless/troubleshooting.mdx
  • Viewed .long_term_context/style/client_style_guide.md

Agent Response

I've reviewed PR #481 and created a documentation suggestion.

Summary

PR #481 fixes how the Python SDK handles corrupted ~/.runpod/config.toml files. Previously, a corrupted config file would crash the SDK at import time with a TOMLDecodeError. After this fix, corrupted files are gracefully handled and treated as if no credentials exist, showing users the standard "No API key found" error with clear remediation steps.

Documentation update

I added a small troubleshooting entry to help users who might encounter this scenario:

File: flash/troubleshooting.mdx

Added section: "Credentials not recognized after login"

  • Explains that seeing "No API key found" after previously running flash login may indicate a corrupted credentials file
  • Provides the solution: delete ~/.runpod/config.toml and re-authenticate with flash login

This entry helps users understand why they might see this error even after a successful login, and provides a clear fix.

Suggestion: Add troubleshooting for corrupted credentials file

runpod/flash PR #282: fix(cli): catch corrupted credentials file at import time

Promptless Research (4 files, 1 GitHub PR)

  • Reviewed runpod/flash#282
  • Viewed .long_term_context/product_knowledge/product_overview.md
  • Viewed .long_term_context/doc_workflow/client_instructions.md
  • Viewed flash/troubleshooting.mdx
  • Viewed .long_term_context/style/client_style_guide.md

Agent Response

I've reviewed PR #282 and updated the documentation.

Summary:
This PR adds a new CLI entrypoint that catches corrupted TOML errors at import time and displays a clean, actionable error message instead of a raw traceback:

Error: ~/.runpod/config.toml is corrupted and cannot be parsed.
Run 'flash login' to re-authenticate, or delete the file and retry.

Documentation update:
I updated an existing suggestion that was already tracking related corrupted credentials troubleshooting (triggered by the related runpod-python PR #481). The updated entry now includes:

  • The specific error message text from this PR
  • Standard troubleshooting format with Error:, Cause:, and Solution: sections
  • Both possible symptoms (the new specific error and the generic "No API key found")

Suggestion: Add troubleshooting for corrupted credentials file

  • File modified: flash/troubleshooting.mdx

Tip: Send Promptless a meeting transcript in Slack to generate doc updates 📝

source ~/.bashrc
```

### Corrupted credentials file
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #481 adds graceful handling for corrupted config.toml files in get_credentials() and set_credentials(). Previously, a corrupted file would crash at import time; now it's treated as no credentials found, showing the "No API key found" message.
View source


**Error:**
```
Error: ~/.runpod/config.toml is corrupted and cannot be parsed.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Error message text from src/runpod_flash/cli/entrypoint.py in this PR. The entrypoint catches TOMLDecodeError at import time and displays this clean error message instead of a raw traceback.
View source

@mintlify
Copy link

mintlify bot commented Mar 24, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
runpod-docs 🟢 Ready View Preview Mar 24, 2026, 4:57 PM

@promptless
Copy link
Contributor Author

promptless bot commented Mar 25, 2026

Just a reminder: If you'd like me to act on any feedback you have via Github comments, just type @Promptless in your suggestion and I'll get right on it! (I won't show up in the user dropdown, but I'll process any request that has @Promptless in the comment body.)

@muhsinking muhsinking merged commit 3bc0fdf into main Mar 25, 2026
3 checks passed
@muhsinking muhsinking deleted the promptless/corrupted-config-troubleshooting branch March 25, 2026 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant