docs: Add uv run variant for all Flash CLI commands#594
Conversation
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| uv run flash login | ||
| ``` | ||
|
|
||
| This saves your API key securely and allows you to use the Flash CLI and run `@Endpoint` functions. |
There was a problem hiding this comment.
Citation: Requested by Mo King in Slack to add note about using uv run flash login when using uv for package management.
View source
| uv run flash login | ||
| ``` | ||
|
|
||
| The command opens your default browser to the Runpod authorization page. After you approve the request, your API key is saved locally for future CLI operations. |
There was a problem hiding this comment.
Citation: Added to the CLI reference for consistency with the overview page.
View source
flash/apps/build-app.mdx
Outdated
| curl -X POST http://localhost:8888/gpu_worker/runsync \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{"message": "Hello from the GPU!"}' | ||
| -d '{"input": {"input_data": {"message": "Hello from the GPU!"}}}' |
There was a problem hiding this comment.
Citation: Fixed curl payload format based on client feedback. Queue-based endpoints require {"input": {...}} wrapper matching the skeleton template's input_data: dict parameter. Verified against the Local testing documentation which documents the correct request format.
View source
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
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.) |
1 participant
Open this suggestion in Promptless to view citations and reasoning process
Updates all Flash CLI documentation to show the
uv runvariant using inline code comments instead of<Tip>blocks. The format shows the standard command followed by the uv variant. Applied across CLI reference pages, overview, quickstart, apps documentation, and tutorials. Also updates the build-app tutorial to useflash loginfor authentication instead of manual API key export, consistent with the quickstart guide. Updatesflash initto show the project name as required (removes optional brackets) and usesflash init .in the build-app tutorial for initializing in the current directory. Fixes curl example payloads to use the correct request format with{"input": {...}}wrapper for queue-based endpoints.Trigger Events
Internal discussion about updating the Flash overview documentation to include uv package management instructions for the login command.
Promptless Research (5 files)
flash/overview.mdx.long_term_context/doc_workflow/client_instructions.md.long_term_context/style/client_style_guide.mdflash/cli/login.mdxflash/quickstart.mdxAgent Response
Tip: Tag @Promptless in GitHub PR comments to guide documentation changes during code review 🐙