jf generate-summary-markdown

Generate a summary of recorded CLI commands in Markdown format. The report is saved in the directory specified by JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR.

Synopsis

jf generate-summary-markdown [options]

Aliases: jf gsm

Arguments

Options

This command has no flags.

Environment Variables

Examples

Generate a Command Summary

export JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR=/tmp/cli-summary
jf gsm

Set the output directory before running. The CLI writes the Markdown report to that path.

Use a Custom Output Directory

JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR=./docs/usage jf gsm

When to Use

Use jf gsm in CI/CD pipelines to generate a human-readable summary of all CLI commands run during a build. Common scenarios:

• Build reports: Attach the Markdown summary as a build artifact for auditing
• Pull request comments: Post the summary as a PR comment to show what was built and deployed
• Documentation: Track CLI usage patterns across builds

Important Notes

• The JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR environment variable must be set before running any JFrog CLI commands you want to capture. The CLI records command summaries to this directory during execution, and jf gsm compiles them.
• The output directory must exist before running the command — the CLI does not create it automatically.
• If no commands were recorded (the output directory is empty), jf gsm produces an empty or minimal report.

Expected Output

The command writes a Markdown file to the specified directory with content like:

# JFrog CLI Command Summary

## Commands Executed
| # | Command | Status | Duration |
|---|---------|--------|----------|
| 1 | jf npm ci | Success | 12s |
| 2 | jf npm publish | Success | 3s |
| 3 | jf rt build-publish my-app 42 | Success | 1s |

## Artifacts
- Uploaded: 3 files (1.2 MB)
- Downloaded: 47 packages