<commit_before># FSDevTools

Project to support developer experience (DX) with FirstSpirit template development by offering a connection between a VCS like Git and FirstSpirit.

## User Documentation

### Prequisites
Installation prerequisites are documented inside the zip or tar-gz file of the binary distribution.

In short, a correct `JAVA_HOME` environment variable must be set which points to a **Java 8** installation.

Some configurations are loaded from your system environment in first instance.
It is possible to override all default values from the environment by passing actual command line options for them.
The following values are read from your environment with the corresponding key.

- **fshost** - The FirstSpirit host address
- **fsport** - The FirstSpirit port number.
- **fsmode** - The FirstSpirit connection mode, either `HTTP` or `SOCKET`.
- **fsuser** - The FirstSpirit user account to authenticate the connection.
- **fspwd** - The FirstSpirit user's password.
- **fsproject** - The FirstSpirit project name.

### Usage
Most of the information you need in order to use the command line tool can be found via the integrated help command.
See `fs-cli help` for more information on how to use the help command.

For more information and examples how to use the command line interface see the [command line interface usage page](documentation/CLI_USAGE.md).

### Logging

By default, every command gives you a more or less detailed, printed result. Use the Log4J logging properties
file `/conf/log4j.properties`, to set a finer logging level as needed.<commit_msg>DEVEX-53 added description for configuration properties default values<commit_after># FSDevTools

Project to support developer experience (DX) with FirstSpirit template development by offering a connection between a VCS like Git and FirstSpirit.

## User Documentation

### Prequisites
Installation prerequisites are documented inside the zip or tar-gz file of the binary distribution.

In short, a correct `JAVA_HOME` environment variable must be set which points to a **Java 8** installation.

Some configurations are loaded from your system environment in first instance.
It is possible to override all default values from the environment by passing actual command line options for them.
The following values are read from your environment with the corresponding key.

- **fshost** - The FirstSpirit host address
- **fsport** - The FirstSpirit port number.
- **fsmode** - The FirstSpirit connection mode, either `HTTP` or `SOCKET`.
- **fsuser** - The FirstSpirit user account to authenticate the connection.
- **fspwd** - The FirstSpirit user's password.
- **fsproject** - The FirstSpirit project name.

Additionally the properties host, port, connection mode, user and password have default values, that are used if neither an environment
variable nor an option is given. The project property doesn't have a default value, so it has to be configured somehow to avoid exceptions
with project context specific operations.

### Usage
Most of the information you need in order to use the command line tool can be found via the integrated help command.
See `fs-cli help` for more information on how to use the help command.

For more information and examples how to use the command line interface see the [command line interface usage page](documentation/CLI_USAGE.md).

### Logging

By default, every command gives you a more or less detailed, printed result. Use the Log4J logging properties
file `/conf/log4j.properties`, to set a finer logging level as needed.
{'fraction_non_alphanumeric': 0.05885666009574768, 'fraction_numerical': 0.002252886510842016, 'mean_word_length': 4.701444622792938, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, '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': '1390039', 'n_tokens_mistral': 866, 'n_tokens_neox': 842, 'n_words': 497}