For the complete documentation index, see llms.txt. This page is also available as Markdown.

AI Assisted Insight Report

The AI-powered report functionality generates comprehensive analysis reports for your Salesforce projects using advanced language models. This feature provides deep insights into code quality, architecture, and best practices specific to the Flxbl framework.

Overview

The report generator analyzes your codebase through multiple perspectives:

  • Package architecture and design patterns

  • Dependencies and coupling between packages

  • Code quality and technical debt

  • Flxbl best practices compliance

  • Security and compliance considerations

Prerequisites

A configured AI provider. Locally, set the provider's API key (e.g. ANTHROPIC_API_KEY); when connected to an sfp server, the report command fetches credentials from the server automatically. For complete setup and configuration instructions, see Configuring LLM Providers.

Basic Usage

Package Analysis

# Analyze single package
sfp project report --package nextGen

# Analyze multiple packages
sfp project report --package core --package utils --output core-utils-analysis.md

Domain Analysis ( sfp-pro only)

Provider-Specific Examples

Amazon Bedrock

Command Flags

sfp project report (alias sfp project:ai-report) accepts:

Flag
Alias
Default
Purpose

--output

analysis-report.md

Output markdown file path.

--package

-p

Package(s) to analyse. Repeatable; mutually exclusive with --domain.

--domain

-d

Domain to analyse (sfp-pro only). Mutually exclusive with --package.

--provider

anthropic

AI provider: anthropic, openai, amazon-bedrock, github-copilot.

--model

provider default

Model id to use.

--prompt-count

all

Limit the number of analysis prompts (useful for quick test runs).

When connected to an sfp server, the command also accepts the standard server flags (--sfp-server-url, --application-token, --repository) and uses them to fetch provider credentials. With no package or domain specified, the whole project is analysed.

Output Format

Reports are generated in Markdown format with the following structure:

  1. Executive Summary - High-level findings and recommendations

  2. Package/Domain Overview - Architecture and design analysis

  3. Dependencies Analysis - Inter-package relationships

  4. Code Quality Insights - Technical debt and improvement opportunities

  5. Recommendations - Prioritized action items

Troubleshooting

Rate Limiting

If you encounter rate limits:

  • Reduce --prompt-count to lower token usage

  • Analyze smaller scopes (single package vs domain)

  • Consider using a different model with higher limits

Last updated

Was this helpful?