<commit_before># Scope

## Overview

TODO

## Developing

### Building

To build everything in-place,

```
make build
```

Note that this doesn't build or include the latest version of the user
interface. The UI is decoupled, living in `client` and following a node/gulp
workflow. To build that and include it in the application binary,

```
make client
make static
make build
```

Or, as a shortcut,

```
make dist
```
<commit_msg>README: update with build and run instructions<commit_after># Scope

## Overview

Weave Scope automatically generates a map of your containers, enabling you to
intuitively understand, monitor, and control your applications.

Please note that the code, and especially the building and running story, is in
a **pre-alpha** state. Please take a look, but don't be surprised if you hit
bugs or missing pieces.

## Building

### In-place

To build the binaries in-place,

```
make build
```

Note that this doesn't build or include the latest version of the user
interface. The UI is decoupled, living in `client` and following a node/gulp
workflow. To build that and include it in the application binary,

```
make client
make static
make build
```

Or, as a shortcut,

```
make dist
```

### Docker container

To build a Docker container,

```
make docker
```

## Running

### Manually

1. Launch a probe process on each physical host you intend to monitor, via `sudo probe`
2. Launch an app process, and configure it to talk to probes, via `app -probes="probe-host-1:4030,probe-host-2:4030"`.
3. Load the user interface, via **http://app-host:4040**

### As a Docker container

TODO

{'fraction_non_alphanumeric': 0.09237445753254804, 'fraction_numerical': 0.010539367637941723, 'mean_word_length': 4.2064516129032254, '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': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7069797', 'n_tokens_mistral': 502, 'n_tokens_neox': 461, 'n_words': 231}