Skip to content

docs: update CLI documentation for deploy, env, and app commands #195

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

Jump to bottom
Open
deanq wants to merge 8 commits into
base: main
Choose a base branch
from
Open

docs: update CLI documentation for deploy, env, and app commands #195

deanq wants to merge 8 commits into from
+4,539 −2,615

Conversation

@deanq
Copy link
Member

@deanq deanq commented Feb 11, 2026

Summary

Comprehensive documentation update for Flash CLI, adding complete reference documentation for previously undocumented commands:

  • flash deploy - Build and deploy workflow
  • flash env - Environment management (list/create/get/delete)
  • flash app - App management (list/create/get/delete)

Changes

New Documentation Files (3)

  1. src/runpod_flash/cli/docs/flash-deploy.md (11KB)

    • Build-then-deploy workflow
    • Environment resolution and auto-creation
    • Post-deployment guidance
    • Preview mode
    • Troubleshooting

  2. src/runpod_flash/cli/docs/flash-env.md (17KB)

    • All 4 subcommands (list/create/get/delete)
    • Environment lifecycle and concepts
    • Common workflows
    • Best practices

  3. src/runpod_flash/cli/docs/flash-app.md (19KB)

    • All 4 subcommands (list/create/get/delete)
    • App hierarchy and organization
    • Relationship to environments
    • Management strategies

Updated Documentation Files (4)

  1. src/runpod_flash/cli/docs/README.md

    • Added deploy, env, and app command sections
    • Logical workflow order: init → run → build → deploy → env → app → undeploy

  2. README.md

    • New CLI Reference section before "Key concepts"
    • Quick examples and command overview
    • Links to complete CLI documentation

  3. src/runpod_flash/cli/docs/flash-build.md

    • Updated cross-references to new docs

  4. docs/Flash_Deploy_Guide.md

    • Added note distinguishing architectural guide from CLI reference

Documentation Quality

All new docs follow established patterns:

  • Structure: Usage → Options → Examples → Concepts → Troubleshooting → Related
  • Style: Direct and concise, practical focus
  • Examples: Real command-line output
  • Cross-references: Comprehensive bidirectional linking

Impact

  • Coverage: All 15+ CLI commands now documented
  • Navigation: Clear path between related commands
  • Discoverability: CLI capabilities prominently featured in main README
  • User experience: Comprehensive reference for all deployment workflows

Test plan

  • All documentation files created and properly formatted
  • Cross-references verified and bidirectional
  • Links point to correct documentation pages
  • Consistent with existing documentation style
  • Main README updated with CLI Reference section
  • Table of Contents updated

deanq added 7 commits February 11, 2026 01:32
@deanq
feat(runtime): add API key management and conditional manifest sync
32dd688 
Optimizes cross-endpoint communication by skipping State Manager queries
for local-only endpoints and injecting API keys only when needed.

- ServiceRegistry checks makes_remote_calls to skip unnecessary queries
- ServerlessResource injects RUNPOD_API_KEY for QB endpoints at deploy time
- Added comprehensive API key management documentation
@deanq
fix(serverless): normalize resource names for manifest lookup
556106d 
Strip -fb suffix and live- prefix from resource names when looking up
configuration in manifest to ensure resources with these naming patterns
are properly matched.
@deanq
docs: add comprehensive CLI documentation for deploy, env, and app co…
94df8bf 
…mmands

Add three new documentation files following established patterns:

- flash-deploy.md: Build and deploy workflow, environment resolution,
  post-deployment guidance, preview mode, and troubleshooting
- flash-env.md: Environment management (list/create/get/delete),
  lifecycle, common workflows, and best practices
- flash-app.md: App management (list/create/get/delete), hierarchy,
  organization strategies, and relationship to environments

All docs include:
- Usage syntax and options
- Real command-line examples with output
- Conceptual explanations
- Troubleshooting sections
- Cross-references to related commands

Total: 47KB of new user-facing documentation
@deanq
docs: update CLI README with deploy, env, and app command sections
952b384 
Add comprehensive sections for previously undocumented commands:

- flash deploy: Build and deploy in one step, with all options and examples
- flash env: Environment management subcommands (list/create/get/delete)
- flash app: App management subcommands (list/create/get/delete)

Each section includes:
- Usage syntax
- Key options
- Practical examples
- Link to full documentation page

Commands now follow logical workflow order:
init → run → build → deploy → env → app → undeploy
@deanq
docs: enhance main README with comprehensive CLI Reference section
4ed64ab 
Add prominent CLI Reference section before "Key concepts" with:

- Overview of all main commands (init, run, build, deploy)
- Management commands (env, app, undeploy)
- Quick examples showing common workflows
- Links to complete CLI documentation
- Individual command reference links

Also enhanced existing sections:
- Added CLI documentation link in "Create Flash API endpoints"
- Added flash run documentation link in "Step 5"
- Updated Table of Contents to include CLI Reference

Makes CLI capabilities more discoverable for new users while
providing clear path to comprehensive documentation.
@deanq
docs: update cross-references between CLI and architectural docs
0151b95 
flash-build.md:
- Updated "Next Steps" with links to deploy and env commands
- Enhanced "Related Commands" with bidirectional links to new docs

Flash_Deploy_Guide.md:
- Added prominent note at top distinguishing architectural guide
  from user-facing CLI documentation
- Links to flash deploy, flash env, and complete CLI docs

Ensures users can easily navigate between:
- Architectural implementation details (Deploy Guide)
- User-facing command references (CLI docs)
- Related commands within CLI documentation
@deanq
docs: update CLAUDE.md with CLI documentation update context
ce054eb 
Document the completed work on this branch:
- Purpose: Update CLI documentation for new commands
- Status: All documentation created and cross-referenced
- Files added: flash-deploy.md, flash-env.md, flash-app.md
- Files updated: CLI README, main README, cross-references

Provides context for future work and Claude Code assistance.
@deanq deanq requested a review from Copilot February 11, 2026 22:32
@deanq deanq changed the title Update CLI documentation for deploy, env, and app commands docs: ppdate CLI documentation for deploy, env, and app commands Feb 11, 2026
@deanq deanq changed the title docs: ppdate CLI documentation for deploy, env, and app commands docs: update CLI documentation for deploy, env, and app commands Feb 11, 2026
Copilot AI reviewed Feb 11, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive CLI documentation for the Flash deployment workflow, covering three previously undocumented command groups (flash deploy, flash env, and flash app) along with supporting implementation changes for API key management in distributed deployments.

Changes:

  • Added complete reference documentation for flash deploy, flash env, and flash app commands
  • Implemented API key injection for queue-based endpoints that make remote calls
  • Added conditional manifest synchronization optimization for local-only endpoints

Reviewed changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/runpod_flash/cli/docs/flash-deploy.md Complete CLI reference for build-and-deploy workflow
src/runpod_flash/cli/docs/flash-env.md Complete environment management documentation (list/create/get/delete)
src/runpod_flash/cli/docs/flash-app.md Complete app management documentation (list/create/get/delete)
src/runpod_flash/cli/docs/README.md Updated with new command sections in logical workflow order
src/runpod_flash/cli/docs/flash-build.md Updated cross-references to new documentation
README.md Added CLI Reference section with quick examples
docs/Flash_Deploy_Guide.md Added note distinguishing architectural guide from CLI reference
docs/API_Key_Management.md New documentation for API key propagation architecture
src/runpod_flash/runtime/service_registry.py Added conditional manifest sync based on makes_remote_calls flag
src/runpod_flash/core/resources/serverless.py Added API key injection for queue-based endpoints
CLAUDE.md Complete rewrite of development patterns documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@deanq
docs: fix PR #195 review issues
8ae3058 
Addresses critical and important issues from PR review:

Critical Fixes:
- Remove CLAUDE.md template file from PR (worktree-specific, not for main)
- Replace "comprehensive" with "complete" (CLAUDE.md style compliance)
- Remove emoji from CLI documentation link

Important Fixes:
- Remove duplicated "Environment:" label in flash-env.md output examples
- Remove redundant example block in flash-app.md (flash app list)
- Remove "Examples with Real Output" sections (duplicated content)
- Remove incorrect LiveServerless SDK example (no 'url' parameter)
- Add note explaining why flash app delete requires --app flag

These changes improve documentation quality, reduce maintenance burden,
and ensure compliance with project style guidelines.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@deanq