Skip to content

docs: Update Flash docs for .runpod to .flash directory migration #592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
muhsinking merged 3 commits into from
Mar 27, 2026
Merged

docs: Update Flash docs for .runpod to .flash directory migration #592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2567dbd
Update Flash docs for .runpod to .flash directory migration
promptless[bot] Mar 24, 2026
21931ca
Merge branch 'main' into promptless/flash-runpod-to-flash-directory-m…
muhsinking Mar 25, 2026
4dc153d
Merge branch 'main' into promptless/flash-runpod-to-flash-directory-m…
muhsinking Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion flash/apps/local-testing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ flash run --auto-provision
uv run flash run --auto-provision
```

This scans your project for `@Endpoint` functions and deploys them before the server starts accepting requests. Endpoints are cached in `.runpod/resources.pkl` and reused across server restarts.
This scans your project for `@Endpoint` functions and deploys them before the server starts accepting requests. Endpoints are cached in `.flash/resources.pkl` and reused across server restarts.
Copy link
Copy Markdown
Contributor Author

@promptless promptless bot Mar 24, 2026

Choose a reason for hiding this comment

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

Citation: PR #221 changes the resource caching directory from .runpod/ to .flash/ as documented in the PR's internal flash-run.md file.
View source


## How it works

Expand Down
2 changes: 1 addition & 1 deletion flash/cli/run.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ flash run --auto-provision
1. **Discovery**: Scans your app for `@Endpoint` decorated functions.
2. **Deployment**: Deploys resources concurrently (up to 3 at a time).
3. **Confirmation**: Asks for confirmation if deploying more than 5 endpoints.
4. **Caching**: Stores deployed resources in `.runpod/resources.pkl` for reuse.
4. **Caching**: Stores deployed resources in `.flash/resources.pkl` for reuse.
Copy link
Copy Markdown
Contributor Author

@promptless promptless bot Mar 24, 2026

Choose a reason for hiding this comment

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

Citation: PR #221 migrates RUNPOD_FLASH_DIR from Path(".runpod") to Path(".flash") in resource_manager.py, and _RESOURCE_STATE_FILE in run.py follows the same change.
View source

5. **Updates**: Recognizes existing endpoints and updates if configuration changed.

### Benefits
Expand Down
4 changes: 2 additions & 2 deletions flash/cli/undeploy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Remove inactive endpoints from tracking without API deletion:
flash undeploy --cleanup-stale
```

Use this when endpoints were deleted via the Runpod console or API (not through Flash). The local tracking file (`.runpod/resources.pkl`) becomes stale, and this command cleans it up.
Use this when endpoints were deleted via the Runpod console or API (not through Flash). The local tracking file (`.flash/resources.pkl`) becomes stale, and this command cleans it up.
Copy link
Copy Markdown
Contributor Author

@promptless promptless bot Mar 24, 2026

Choose a reason for hiding this comment

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

Citation: PR #221 consolidates all local state under .flash/ directory, eliminating the .runpod/ paradigm. The tracking file path is now .flash/resources.pkl.
View source


## Flags

Expand Down Expand Up @@ -137,7 +137,7 @@ For production deployments, use `flash env delete` to remove entire environments

## How tracking works

Flash tracks deployed endpoints in `.runpod/resources.pkl`. Endpoints are added when you:
Flash tracks deployed endpoints in `.flash/resources.pkl`. Endpoints are added when you:
Copy link
Copy Markdown
Contributor Author

@promptless promptless bot Mar 24, 2026

Choose a reason for hiding this comment

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

Citation: Based on changes in resource_manager.py where RESOURCE_STATE_FILE now points to .flash/resources.pkl.
View source


- Run `flash run --auto-provision`
- Run `flash run` and call `@Endpoint` functions
Expand Down
Loading