<commit_before>= PHPREFLECT(1)
:doctype:     manpage
include::revision.asciidoc[]
include::attributes.asciidoc[]
:author!:


== NAME
phpreflect - Reverse-engineer classes, interfaces, functions, constants, namespaces and more


== SYNOPSIS
*phpreflect* ['options'] 'command' ['arguments']


== DESCRIPTION
The phpreflect(1) command parse any data source, to find out
elements, such as classes, interfaces, functions, constants, namespaces.


== OPTIONS
*-h, --help*::
    Display this help message.

*-q, --quiet*::
    Do not output any message.

*-v|vv|v, --verbose*::
    Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.

*-V, --version*::
    Display this application version.

*--ansi*::
    Force ANSI output.

*--no-ansi*::
    Disable ANSI output.

*--profile*::
    Display timing and memory usage information.

*--progress*::
    Show progress bar.

*--output*::
    Write results to file or URL.

*--manifest*::
   Show which versions of dependencies are bundled (PHAR version only).


== diagnose:run COMMAND
The phpreflect(1) 'diagnose:run' command is used to identify common errors on a platform.

Usage:

  phpreflect diagnose:run [-vv|-vvv]


== diagram:class COMMAND
The phpreflect(1) 'diagram:class' command is used to generate diagram about a user class present in a data source

Usage:

  phpreflect diagram:class [--alias] [--engine[="..."]] argument source

Where:

*argument*::
  Name of the class to inspect

*source*::
  Identify a data source; may be declared in a json configuration file (see <<X1,CONF FILES>> section)

*--alias*::
  If set, the source refers to its alias

*--engine*::
  Graphical syntax. (default: "plantuml")


== diagram:package COMMAND
The phpreflect(1) 'diagram:package' command is used to generate diagram about namespaces in a data source

Usage:

  phpreflect diagram:package [--alias] [--engine[="..."]] argument source

Where:

*argument*::
  Name of the namespace to inspect

*source*::
  Identify a data source; may be declared in a json configuration file (see <<X1,CONF FILES>> section)

*--alias*::
  If set, the source refers to its alias

*--engine*::
  Graphical syntax. (default: "plantuml")


== config:validate COMMAND
The phpreflect(1) 'config:validate' command is used to check syntax of your json configuration file

Usage:

  phpreflect config:validate [file]

Where:

*file*::
  Path to `phpreflect.json` file (optional)


== analyser:list COMMAND
The phpreflect(1) 'analyser:list' command is used to show what analysers are installed
(see <<X1,CONF FILES>> section).


== analyser:run COMMAND
The phpreflect(1) 'analyser:run' command is used to analyse a data source and display results.

Usage:

  phpreflect analyser:run [--alias] [--format="..."] source [analysers1] ... [analysersN]

Where:

*source*::
  Identify a data source; may be declared in a json configuration file (see <<X1,CONF FILES>> section)

*--alias*::
  If set, the source refers to its alias

*--format*::
  If set, convert result to a specific format. (default: "json")

*analysers1* ... *analysersN*::
  Identify one or more analyser to execute. See 'analyser:list' command to know what analysers are available.
  (default: ["structure"])


== plugin:list COMMAND
The phpreflect(1) 'plugin:list' command is used to show what plugins are installed
(see <<X1,CONF FILES>> section).


== reflection:class COMMAND
The phpreflect(1) 'reflection:class' command is used to give information about a user class present in a data source.
<commit_msg>re-order commands list<commit_after>= PHPREFLECT(1)
:doctype:     manpage
include::revision.asciidoc[]
include::attributes.asciidoc[]
:author!:


== NAME
phpreflect - Reverse-engineer classes, interfaces, functions, constants, namespaces and more


== SYNOPSIS
*phpreflect* ['options'] 'command' ['arguments']


== DESCRIPTION
The phpreflect(1) command parse any data source, to find out
elements, such as classes, interfaces, functions, constants, namespaces.


== OPTIONS
*-h, --help*::
    Display this help message.

*-q, --quiet*::
    Do not output any message.

*-v|vv|v, --verbose*::
    Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.

*-V, --version*::
    Display this application version.

*--ansi*::
    Force ANSI output.

*--no-ansi*::
    Disable ANSI output.

*--profile*::
    Display timing and memory usage information.

*--progress*::
    Show progress bar.

*--output*::
    Write results to file or URL.

*--manifest*::
   Show which versions of dependencies are bundled (PHAR version only).


== analyser:list COMMAND
The phpreflect(1) 'analyser:list' command is used to show what analysers are installed
(see <<X1,CONF FILES>> section).


== analyser:run COMMAND
The phpreflect(1) 'analyser:run' command is used to analyse a data source and display results.

Usage:

  phpreflect analyser:run [--alias] [--format="..."] source [analysers1] ... [analysersN]

Where:

*source*::
  Identify a data source; may be declared in a json configuration file (see <<X1,CONF FILES>> section)

*--alias*::
  If set, the source refers to its alias

*--format*::
  If set, convert result to a specific format. (default: "json")

*analysers1* ... *analysersN*::
  Identify one or more analyser to execute. See 'analyser:list' command to know what analysers are available.
  (default: ["structure"])


== config:validate COMMAND
The phpreflect(1) 'config:validate' command is used to check syntax of your json configuration file

Usage:

  phpreflect config:validate [file]

Where:

*file*::
  Path to `phpreflect.json` file (optional)


== diagnose:run COMMAND
The phpreflect(1) 'diagnose:run' command is used to identify common errors on a platform.

Usage:

  phpreflect diagnose:run [-vv|-vvv]


== diagram:class COMMAND
The phpreflect(1) 'diagram:class' command is used to generate diagram about a user class present in a data source

Usage:

  phpreflect diagram:class [--alias] [--engine[="..."]] argument source

Where:

*argument*::
  Name of the class to inspect

*source*::
  Identify a data source; may be declared in a json configuration file (see <<X1,CONF FILES>> section)

*--alias*::
  If set, the source refers to its alias

*--engine*::
  Graphical syntax. (default: "plantuml")


== diagram:package COMMAND
The phpreflect(1) 'diagram:package' command is used to generate diagram about namespaces in a data source

Usage:

  phpreflect diagram:package [--alias] [--engine[="..."]] argument source

Where:

*argument*::
  Name of the namespace to inspect

*source*::
  Identify a data source; may be declared in a json configuration file (see <<X1,CONF FILES>> section)

*--alias*::
  If set, the source refers to its alias

*--engine*::
  Graphical syntax. (default: "plantuml")


== plugin:list COMMAND
The phpreflect(1) 'plugin:list' command is used to show what plugins are installed
(see <<X1,CONF FILES>> section).


== reflection:class COMMAND
The phpreflect(1) 'reflection:class' command is used to give information about a user class present in a data source.

{'fraction_non_alphanumeric': 0.12152434721242061, 'fraction_numerical': 0.0056457304163726185, 'mean_word_length': 4.202643171806168, 'pattern_counts': {'":': 0, '<': 23, '<?xml version=': 0, '>': 23, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2197205', 'n_tokens_mistral': 2255, 'n_tokens_neox': 2146, 'n_words': 864}