Skip to content

Docs: document pipeline CLI flags#84

Merged
PrzemyslawKlys merged 1 commit intomainfrom
codex/docs-pipeline-cli-flags
Feb 8, 2026
Merged

Docs: document pipeline CLI flags#84
PrzemyslawKlys merged 1 commit intomainfrom
codex/docs-pipeline-cli-flags

Conversation

@PrzemyslawKlys
Copy link
Member

Docs/PowerForge.Web.Pipeline.md: add a short section documenting powerforge-web pipeline flags (--fast, --dev, --mode, --only, --skip).

Copilot AI review requested due to automatic review settings February 8, 2026 09:09
@claude
Copy link

claude bot commented Feb 8, 2026

PR Review: Document Pipeline CLI Flags

Thank you for adding documentation for the pipeline CLI flags! This is a valuable addition that will help users iterate faster during local development.

Code Quality: ✅ Excellent

The documentation follows the established patterns in this file:

  • Clear section header matching the document's style
  • Concise introductory sentence explaining the purpose
  • Well-organized bullet list with consistent formatting
  • Proper placement within the document structure (after the minimal pipeline example, before "Supported steps")

Content Review: ✅ Strong

Strengths:

  • All five flags are documented with clear, concise descriptions
  • The relationship between --fast and --dev is well explained (--dev implies --fast)
  • Good use of concrete examples (e.g., "scopes optimize/audit when possible and disables expensive rendered checks")
  • Consistent formatting with comma-separated task lists for --only and --skip

Minor suggestions for consideration:

  1. Expand --mode description slightly: The current description says it's "used for logging/diagnostics" - it might be helpful to clarify if this mode label appears in the pipeline output or if it affects behavior in any way. For example:

    - `--mode <name>`: attaches a mode label to the run (displayed in pipeline logs for diagnostics).
    
  2. Add usage examples (optional): Consider adding a brief example section showing common flag combinations, such as:

    Common usage:
    ```bash
    # Fast local iteration
    powerforge-web pipeline --dev pipeline.json
    
    # Run only build and verify steps
    powerforge-web pipeline --only build,verify pipeline.json
    
    # Skip expensive audit checks
    powerforge-web pipeline --skip audit pipeline.json
    
    However, this might be better suited for the QuickStart guide rather than the Pipeline spec reference.
    
    
  3. Cross-reference to related sections: The --fast flag mentions "scopes optimize/audit" - readers might benefit from knowing these behaviors are documented in the optimize and audit step sections below (specifically the scopeFromBuildUpdated parameter mentioned in lines 326 and 355 of the full document).

Documentation Standards: ✅ Compliant

  • Style consistency: Matches the tone and formatting of other sections in PowerForge.Web.Pipeline.md
  • Technical accuracy: The descriptions align with the documented step parameters (e.g., scopeFromBuildUpdated in optimize/audit steps)
  • Placement: Logically positioned early in the document where users would look for it

Test Coverage: N/A

This is documentation-only, no code changes.

Security Concerns: None

No security implications.

Performance Considerations: N/A

The documented flags themselves are performance-focused features, which is well described.

Overall Assessment: ✅ Approved

This is a clean, focused documentation improvement that enhances the developer experience. The writing is clear, the content is accurate, and it fits well within the existing documentation structure.

Recommendation: Merge as-is, with optional consideration of the minor suggestions above in a future update if desired.


Review generated with assistance from Claude Code

Copy link

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

Adds documentation for the powerforge-web pipeline CLI flags used to speed up local development runs, aligning the pipeline spec guide with the CLI’s supported options.

Changes:

  • Documented pipeline CLI flags: --fast, --dev, --mode, --only, --skip.
  • Positioned the new “CLI flags” section near the minimal pipeline example for quick discoverability.

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

@PrzemyslawKlys PrzemyslawKlys merged commit 0ce1e19 into main Feb 8, 2026
7 checks passed
@PrzemyslawKlys PrzemyslawKlys deleted the codex/docs-pipeline-cli-flags branch February 8, 2026 09:13
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.

2 participants