• Intro Headers Instructions Macros Commands
Fork me on GitHub
    • Getting Started
      • Introduction
      • How to install bnd
      • Guided Tour Workspace & Projects
      • bnd / bndlib Features and JAR Wrapping Techniques
      • FAQ - Frequently Asked Questions
    • Concepts and Practices
      • Concepts
      • Background
      • Best practices
    • Build and Development
      • Build
      • Generating JARs
      • Versioning
      • Baselining
      • Service Components
      • Metatype
      • Contracts
      • Bundle Annotations
      • Accessor Properties
      • SPI Annotations
    • Dependency and Launching
      • Resolving Dependencies
      • Launching
      • Startlevels
    • Testing
      • Testing
      • Testing with Launchpad
    • Packaging and Distribution
      • Packaging Applications
      • JPMS Libraries
      • Wrapping Libraries to OSGi Bundles
    • Documentation and Tools
      • Generating Documentation
      • bnd CLI Commands
      • For Developers
      • Templates for Workspaces
      • Tips for Windows users
      • Tools bound to bnd
    • Reference Material
      • Reference
      • Headers
      • Instruction Reference
      • Instruction Index
      • Macro Reference
      • Macro Index
      • Plugins
      • External Plugins
    • Configuration and Troubleshooting
      • Settings
      • Errors
      • Warnings
  • exportreport

    Prev Next

    Description

    Generate and export reports of a workspace, a project or of a jar.

    Synopsis:

       exportreport  <[list | export | jarexport | readme | jarreadme]> ...
    

    Available sub-commands

    • export - Export the user defined reports.
    • jarexport - Export a custom report of a Jar.
    • jarreadme - Export a readme file of a Jar (template can be parametrized with system properties starting with ‘bnd.reporter.*’).
    • list - List the user defined reports.
    • readme - Export a set of readme files (template can be parametrized with system properties starting with ‘bnd.reporter.*’).

    export

    Export the user defined reports.

    Synopsis:

       export [options]  ...
    
    Options:
    • [ -e --exclude <string;> ] Exclude files by pattern
    • [ -p --project <string> ] Identify another project
    • [ -v --verbose ] prints more processing information
    • [ -w --workspace <string> ] Use the following workspace

    jarexport

    Export a custom report of a Jar.

    Synopsis:

       jarexport [options]  <jar path> <output path>
    
    Options:
    • [ -c --configName <string> ] A configuration name defined in the property file (check -reportconfig documentation), if not set a default configuration will be used.
    • [ -l --locale <string> ] A locale (language-COUNTRY-variant) used to localized the report data.
    • [ -p --parameters <string;> ] A list of parameters that will be provided to the transformation process if any. eg: –parameters ‘param1=value1,param2=value2’
    • [ -P --properties <string> ] Path to a property file
    • [ -t --template <string> ] Path or URL to a template file used to transform the generated report (twig or xslt). eg: –template bundle.xslt
    • [ -T --templateType <string> ] The template type (aka template file extension), must be set if it could not be guess from the template file name.

    jarreadme

    Export a readme file of a Jar (template can be parametrized with system properties starting with ‘bnd.reporter.*’).

    Synopsis:

       jarreadme [options]  <jar path> <output path>
    
    Options:
    • [ -e --exclude <string;> ] Exclude files by pattern
    • [ -p --project <string> ] Identify another project
    • [ -v --verbose ] prints more processing information
    • [ -w --workspace <string> ] Use the following workspace

    list

    List the user defined reports.

    Synopsis:

       list [options]  ...
    
    Options:
    • [ -e --exclude <string;> ] Exclude files by pattern
    • [ -p --project <string> ] Identify another project
    • [ -v --verbose ] prints more processing information
    • [ -w --workspace <string> ] Use the following workspace

    readme

    Export the user defined reports.

    Synopsis:

       readme [options]  ...
    
    Options:
    • [ -e --exclude <string;> ] Exclude files by pattern
    • [ -p --project <string> ] Identify another project
    • [ -v --verbose ] prints more processing information
    • [ -w --workspace <string> ] Use the following workspace
Prev Next
Search
    • Home