<commit_before># amazee.io Command Line Interface

## Installation

Install `io` with either `npm` or `yarn`.

```sh
# Either npm...
npm install --global @amazeeio/amazee-io-cli

# ...or Yarn
yarn global add @amazeeio/amazee-io-cli
```

## Setup

`io` needs a configuration file at `<project directory>/.amazeeio.yml`, which can be created with [the `init` command](#io-init):

```sh
# Initialize project configuration
io init
```

For more options, see the [`io init` documentation](#io-init).

## Commands

### `io init`

```text
$ io init --help
io init - Create a .amazeeio.yml config file in the current working
directory

Options:
  --help           Show help                                           [boolean]
  --overwrite      Overwrite the configuration file if it exists       [boolean]
  --sitegroup, -s  Name of sitegroup to configure                       [string]

Examples:
  io init                           Create a config file at
                                    ./.amazeeio.yml. This will confirm
                                    with the user whether to overwrite
                                    the config if it already exists and
                                    also prompt for a sitegroup name to
                                    add to the config.

  io init --overwrite               Overwrite existing config file (do
                                    not confirm with the user).

  io init --overwrite false         Prevent overwriting of existing
                                    config file (do not confirm with
                                    user).

  io init --sitegroup my_sitegroup  Set sitegroup to "my_sitegroup" (do
                                    not prompt the user).

  io init -s my_sitegroup           Short form for setting sitegroup to
                                    "my_sitegroup" (do not prompt the
                                    user).

  io init --overwrite --sitegroup   Overwrite existing config files and
  my_sitegroup                      set sitegroup to "my_sitegroup" (do
                                    not confirm with or prompt the
                                    user).
```

#### `io init` Examples<commit_msg>Fix formatting of option descriptions<commit_after># amazee.io Command Line Interface

## Installation

Install `io` with either `npm` or `yarn`.

```sh
# Either npm...
npm install --global @amazeeio/amazee-io-cli

# ...or Yarn
yarn global add @amazeeio/amazee-io-cli
```

## Setup

`io` needs a configuration file at `<project directory>/.amazeeio.yml`, which can be created with [the `init` command](#io-init):

```sh
# Initialize project configuration
io init
```

For more options, see the [`io init` documentation](#io-init).

## Commands

### `io init`

```text
$ io init --help
io init - Create a .amazeeio.yml config file in the current working
directory

Options:
  --help           Show help                                           [boolean]
  --overwrite      Overwrite the configuration file if it exists       [boolean]
  --sitegroup, -s  Name of sitegroup to configure                       [string]

Examples:
  io init                           Create a config file at ./.amazeeio.yml.
                                    This will confirm with the user whether to
                                    overwrite the config if it already exists
                                    and also prompt for a sitegroup name to add
                                    to the config.

  io init --overwrite               Overwrite existing config file (do not
                                    confirm with the user).

  io init --overwrite false         Prevent overwriting of existing config file
                                    (do not confirm with user).

  io init --sitegroup my_sitegroup  Set sitegroup to "my_sitegroup" (do not
                                    prompt the user).

  io init -s my_sitegroup           Short form for setting sitegroup to
                                    "my_sitegroup" (do not prompt the user).

  io init --overwrite --sitegroup   Overwrite existing config files and set
  my_sitegroup                      sitegroup to "my_sitegroup" (do not confirm
                                    with or prompt the user).
```

#### `io init` Examples
{'fraction_non_alphanumeric': 0.07172605275335493, 'fraction_numerical': 0.0, 'mean_word_length': 1.430016863406408, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 31, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3338174', 'n_tokens_mistral': 1076, 'n_tokens_neox': 1001, 'n_words': 435}