<commit_before># Our Boxen

This is CYLENT System's Boxen project, created from Github's Boxen template
project: https://github.com/boxen/our-boxen

See the template project for more detailed information on Boxen.

## Getting Started

The following sections will help:

* Install dependencies (basically Xcode)
* Bootstrap a boxen for yourself

There are a few potential conflicts to keep in mind.
Boxen does its best not to get in the way of a dirty system,
but you should check into the following before attempting to install your
boxen on any machine (we do some checks before every Boxen run to try
and detect most of these and tell you anyway):

* Boxen __requires__ at least the Xcode Command Line Tools installed.
* Boxen __will not__ work with an existing rvm install.
* Boxen __may not__ play nice with a GitHub username that includes dash(-)
* Boxen __may not__ play nice with an existing rbenv install.
* Boxen __may not__ play nice with an existing chruby install.
* Boxen __may not__ play nice with an existing homebrew install.
* Boxen __may not__ play nice with an existing nvm install.
* Boxen __recommends__ installing the full Xcode.

### Dependencies

#### Install Xcode
This will grant you the most predictable behavior in building apps like
MacVim.

How do you do it?

1. Install Xcode from the Mac App Store.
1. Complete the installation by opening the Xcode app, accepting the licentse agreement, and waiting until the installation completes.
1. Open a terminal, and run `xcode-select --install` to install the Xcode command line tools


#### CYLENT Github Organization
Ensure that your github account has been added to the CYLENT github organization, and that you have been added to the appropriate teams. Boxen requires access to some private CYLENT repositories, and so will fail if you don't have access.

If you received an email invitation to the CYLENT github organization, make sure that you have accepted the invitation before proceeding.

#### Enable FileVault
FileVault must be enabled prior to running boxen. After enabling FileVault, make sure to reboot before proceeding.

If you must run boxen without enabling FileVault (which should be avoided), you can run boxen with the `--no-fde` option.

### Bootstrapping

Run the following commands to bootstrap your boxen environment. This only needs
to be done once.

```
sudo mkdir -p /opt/boxen
sudo chown -R ${USER}:staff /opt/boxen
git clone https://github.com/barklyprotects/our-boxen.git /opt/boxen/repo
```

Next, create your user-specific boxen file from the default:

```
cd /opt/boxen/repo/modules/people/manifests
cp default.pp <your-github-username>.pp
```

Then open the newly created .pp file, and change the top line from "people::default" to "people::(your-github-username)"

Now that your boxen is bootstrapped, you can run the following to
install the default configuration from this repo. __Running boxen the first time will take awhile__.

```
cd /opt/boxen/repo
./script/boxen
```

Assuming that runs successfully, open a new tab/window in your Terminal
and you should be able to successfully run `boxen --env`.
If that runs cleanly, you're in good shape.
<commit_msg>Added sudo to git clone step<commit_after># Our Boxen

This is CYLENT System's Boxen project, created from Github's Boxen template
project: https://github.com/boxen/our-boxen

See the template project for more detailed information on Boxen.

## Getting Started

The following sections will help:

* Install dependencies (basically Xcode)
* Bootstrap a boxen for yourself

There are a few potential conflicts to keep in mind.
Boxen does its best not to get in the way of a dirty system,
but you should check into the following before attempting to install your
boxen on any machine (we do some checks before every Boxen run to try
and detect most of these and tell you anyway):

* Boxen __requires__ at least the Xcode Command Line Tools installed.
* Boxen __will not__ work with an existing rvm install.
* Boxen __may not__ play nice with a GitHub username that includes dash(-)
* Boxen __may not__ play nice with an existing rbenv install.
* Boxen __may not__ play nice with an existing chruby install.
* Boxen __may not__ play nice with an existing homebrew install.
* Boxen __may not__ play nice with an existing nvm install.
* Boxen __recommends__ installing the full Xcode.

### Dependencies

#### Install Xcode
This will grant you the most predictable behavior in building apps like
MacVim.

How do you do it?

1. Install Xcode from the Mac App Store.
1. Complete the installation by opening the Xcode app, accepting the licentse agreement, and waiting until the installation completes.
1. Open a terminal, and run `xcode-select --install` to install the Xcode command line tools


#### CYLENT Github Organization
Ensure that your github account has been added to the CYLENT github organization, and that you have been added to the appropriate teams. Boxen requires access to some private CYLENT repositories, and so will fail if you don't have access.

If you received an email invitation to the CYLENT github organization, make sure that you have accepted the invitation before proceeding.

#### Enable FileVault
FileVault must be enabled prior to running boxen. After enabling FileVault, make sure to reboot before proceeding.

If you must run boxen without enabling FileVault (which should be avoided), you can run boxen with the `--no-fde` option.

### Bootstrapping

Run the following commands to bootstrap your boxen environment. This only needs
to be done once.

```
sudo mkdir -p /opt/boxen
sudo chown -R ${USER}:staff /opt/boxen
sudo git clone https://github.com/barklyprotects/our-boxen.git /opt/boxen/repo
```

Next, create your user-specific boxen file from the default:

```
cd /opt/boxen/repo/modules/people/manifests
cp default.pp <your-github-username>.pp
```

Then open the newly created .pp file, and change the top line from "people::default" to "people::(your-github-username)"

Now that your boxen is bootstrapped, you can run the following to
install the default configuration from this repo. __Running boxen the first time will take awhile__.

```
cd /opt/boxen/repo
./script/boxen
```

Assuming that runs successfully, open a new tab/window in your Terminal
and you should be able to successfully run `boxen --env`.
If that runs cleanly, you're in good shape.

{'fraction_non_alphanumeric': 0.05878654511160013, 'fraction_numerical': 0.0009430996541967935, 'mean_word_length': 4.369620253164557, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 4, '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': '3763782', 'n_tokens_mistral': 1761, 'n_tokens_neox': 1680, 'n_words': 932}