docs: Rename flash run to flash dev and document implicit endpoint resolution#619
docs: Rename flash run to flash dev and document implicit endpoint resolution#619promptless[bot] wants to merge 3 commits intomainfrom
Conversation
- Rename flash/cli/run.mdx to flash/cli/dev.mdx - Update all references from flash run to flash dev across docs - Document new implicit endpoint resolution feature with FLASH_APP and FLASH_ENV environment variables - Add note that flash run is a hidden alias for backward compatibility
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| @@ -1,32 +1,36 @@ | |||
| --- | |||
There was a problem hiding this comment.
PR #324 renamed flash run to flash dev with flash run as a hidden alias for backward compatibility. The CLI registration in main.py:42-43 shows both commands pointing to the same handler.
Source: runpod/flash#324
| return {"classification": result} | ||
| ``` | ||
|
|
||
| ## Call deployed endpoints from scripts |
There was a problem hiding this comment.
PR #324 introduced implicit endpoint resolution via FLASH_APP and FLASH_ENV environment variables. The flash_context.py:17-37 module reads these env vars, and client.py:236-275 uses them in the @remote wrapper decision tree to route calls through the Flash sentinel service.
Source: runpod/flash#324
There was a problem hiding this comment.
these environment variables should only be used to override (e.g. running the script in a different cwd and need to target the same app as before)
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
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.) |
KAJdev
left a comment
KAJdev
left a comment
There was a problem hiding this comment.
some clarifications needed
|
@Promptless the environment variables should only be used when they need to be overridden. for example, if you moved the script to a different directory the resolved app name would be different. if you still want to target the original app you need to set FLASH_APP. |
Updates the "Call deployed endpoints from scripts" section to explain that Flash automatically resolves app context from project structure. FLASH_APP and FLASH_ENV are now documented as override mechanisms for special cases, such as when a script is moved to a different directory. Addresses reviewer feedback from PR #619.
|
Thanks for the feedback @KAJdev! I've updated the documentation to clarify that:
The "Set the environment context" section has been replaced with an "Override the resolved context" section that explains when and why you'd use these environment variables. |
|
@Promptless also, the example should probably be calling within the same script and then that you can also import in another script |
Show calling the endpoint within the same script first, then importing from another script as an alternative pattern.
|
Thanks for the feedback @KAJdev! I've updated the example section to show:
The changes have been pushed to this PR. |
1 participant
Open this suggestion in Promptless to view citations and reasoning process
Updates Flash CLI documentation to reflect the
flash runtoflash devrename, and documents the new implicit endpoint resolution feature that allows calling deployed endpoints from scripts usingFLASH_APPandFLASH_ENVenvironment variables.Trigger Events
Tip: Worried about broken links? Ask Promptless to find and fix them automatically 🔗