<commit_before># GETTING STARTED

## INTRODUCTION

## INSTALLING

### INSTALLING NODE.JS

Before installing amok, you need to install [node.js](http://nodejs.org) v0.12 or greater
since amok is written in JavaScript targeting the node runtime.

If you're using Mac or Windows the best way to install node.js is to use one of
the installers from [http://nodejs.org](http://nodejs.org), on Linux it should
be available via the system package manager like `apt-get` or `yum`.

### INSTALLING AMOK

Once node.js and npm is installed, amok can be installed from npm by running the following
command from the command line

```sh
$ npm install --global amok
```

Installing globally is recommended to have the command always available from any command line session by default.

Depending on your system configuration, the command may need to be run with
elevated user privileges.

If you see any errors regarding optional dependencies during the installation you can safely ignore them.

## WORKING WITH A BROWSER

### CONNECTING TO AN EXISTING BROWSER

You can connect to a page in an existing browser page by providing amok with the url of that page.

```sh
$ amok http://localhost:4000<commit_msg>Emphasize node version in getting_started.md<commit_after># GETTING STARTED

## INTRODUCTION

## INSTALLING

### INSTALLING NODE.JS

Before installing amok, you need to install [node.js](http://nodejs.org) **v0.12 or greater**
since amok is written in JavaScript targeting the node runtime.

If you're using Mac or Windows the best way to install node.js is to use one of
the installers from [http://nodejs.org](http://nodejs.org), on Linux it should
be available via the system package manager like `apt-get` or `yum`.

### INSTALLING AMOK

Once node.js and npm is installed, amok can be installed from npm by running the following
command from the command line

```sh
$ npm install --global amok
```

Installing globally is recommended to have the command always available from any command line session by default.

Depending on your system configuration, the command may need to be run with
elevated user privileges.

If you see any errors regarding optional dependencies during the installation you can safely ignore them.

## WORKING WITH A BROWSER

### CONNECTING TO AN EXISTING BROWSER

You can connect to a page in an existing browser page by providing amok with the url of that page.

```sh
$ amok http://localhost:4000
{'fraction_non_alphanumeric': 0.06567534076827757, 'fraction_numerical': 0.0057827344072697235, 'mean_word_length': 4.40625, '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': '5172358', 'n_tokens_mistral': 698, 'n_tokens_neox': 649, 'n_words': 349}