<commit_before>ALCHEMIST - Console Project Manager
===========

Alchemist helps you create, manage and work with your projects, easy to configure and fast to use anywhere, configuration is portable.

[![Build Status](https://travis-ci.org/alchemist-org/alchemist.svg?branch=master)](https://travis-ci.org/alchemist-org/alchemist)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) 

![ScreenShot](https://raw.github.com/alchemist-org/alchemist/master/examples/alchemist.png)

## Example of usage

- i want reinstall and after that i want immediately again work on projects (see link below)
- i have repositories which i want install to someone (e.g. newbie in company)
- i want to have overview over my all projects (uncommited changes etc.)

## Reference

[Elementary OS Loki Ubuntu 16.04 - post installation script](https://gist.github.com/ldrahnik/06d13c7707e1f3c1bfdade2f054b71e8)

## Requirements

Check [composer.json](https://github.com/alchemist-org/alchemist/blob/master/composer.json) for dependencies.

## Installation

Install alchemist manually:

```sh
$ git clone git@github.com:alchemist-org/alchemist.git <alchemist/location>
$ cd <alchemist/location>
$ composer install
```

or using `alchemist-setup.php` located in root of repository:

```sh
$ php alchemist-setup.php --install-dir=/usr/local/bin [--filename=[default='alchemist']] [--force]
```

Will be installed in path `/usr/local/bin/alchemist/<repository>` so path for alias is in this case `/usr/local/bin/alchemist/bin/alchemist.php`.

## Symlink or temporary / permanent alias

```
sudo ln -sf /home/ldrahnik/projects/alchemist/bin/alchemist.php /usr/local/bin/alchemist
```

Or make temporary or permanent global alias (on Linux put the row to the ~.bash_aliases or directly ~.bashrc file):

```
$ alias alchemist='php <alchemist/location>/bin/alchemist.php'
```

For `<alchemist/location>` you can later use command `$ alchemist which`.

## Usage

### Set up

Create and set up `config.local.neon`. For example:

```
parameters:
	projects-dir: default
	hosts: /etc/hosts
	tld: dev
	localhost: 127.0.0.1
	nginx-sites-enabled: /etc/nginx/sites-enabled
	nginx-virtual-host-default: <alchemist-location>/data/virtual-hosts/nginx.default
	apache-sites-enabled: /etc/apache2/sites-enabled
	apache-virtual-host-default: <alchemist-location>/data/virtual-hosts/apache.default
	port: 80
	root: www
	name: '<NAME>'
	email: <EMAIL>
core:
	source-types:
		git:
			- 'git clone --depth=50 <value> <project-dir>'
	projects-dirs:
		nginx:
			path: /usr/share/nginx
			template: nginx

		apache:
			path: /var/www
			template: apache
<commit_msg>Readme.md: add info about --depth=50, git is included by default but without that<commit_after>ALCHEMIST - Console Project Manager
===========

Alchemist helps you create, manage and work with your projects, easy to configure and fast to use anywhere, configuration is portable.

[![Build Status](https://travis-ci.org/alchemist-org/alchemist.svg?branch=master)](https://travis-ci.org/alchemist-org/alchemist)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) 

![ScreenShot](https://raw.github.com/alchemist-org/alchemist/master/examples/alchemist.png)

## Example of usage

- i want reinstall and after that i want immediately again work on projects (see link below)
- i have repositories which i want install to someone (e.g. newbie in company)
- i want to have overview over my all projects (uncommited changes etc.)

## Reference

[Elementary OS Loki Ubuntu 16.04 - post installation script](https://gist.github.com/ldrahnik/06d13c7707e1f3c1bfdade2f054b71e8)

## Requirements

Check [composer.json](https://github.com/alchemist-org/alchemist/blob/master/composer.json) for dependencies.

## Installation

Install alchemist manually:

```sh
$ git clone <EMAIL>.com:alchemist-org/alchemist.git <alchemist/location>
$ cd <alchemist/location>
$ composer install
```

or using `alchemist-setup.php` located in root of repository:

```sh
$ php alchemist-setup.php --install-dir=/usr/local/bin [--filename=[default='alchemist']] [--force]
```

Will be installed in path `/usr/local/bin/alchemist/<repository>` so path for alias is in this case `/usr/local/bin/alchemist/bin/alchemist.php`.

## Symlink or temporary / permanent alias

```
sudo ln -sf /home/ldrahnik/projects/alchemist/bin/alchemist.php /usr/local/bin/alchemist
```

Or make temporary or permanent global alias (on Linux put the row to the ~.bash_aliases or directly ~.bashrc file):

```
$ alias alchemist='php <alchemist/location>/bin/alchemist.php'
```

For `<alchemist/location>` you can later use command `$ alchemist which`.

## Usage

### Set up

Create and set up `config.local.neon`. For example:

```
parameters:
	projects-dir: default
	hosts: /etc/hosts
	tld: dev
	localhost: 127.0.0.1
	nginx-sites-enabled: /etc/nginx/sites-enabled
	nginx-virtual-host-default: <alchemist-location>/data/virtual-hosts/nginx.default
	apache-sites-enabled: /etc/apache2/sites-enabled
	apache-virtual-host-default: <alchemist-location>/data/virtual-hosts/apache.default
	port: 80
	root: www
	name: '<NAME>'
	email: <EMAIL>
core:
	source-types:
		git:
			- 'git clone --depth=50 <value> <project-dir>' # --depth=50 is not included by default 
	projects-dirs:
		nginx:
			path: /usr/share/nginx
			template: nginx

		apache:
			path: /var/www
			template: apache

{'fraction_non_alphanumeric': 0.13734455010972935, 'fraction_numerical': 0.012801755669348939, 'mean_word_length': 4.490963855421687, 'pattern_counts': {'":': 0, '<': 26, '<?xml version=': 0, '>': 26, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 3, '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': '1236595', 'n_tokens_mistral': 1984, 'n_tokens_neox': 1844, 'n_words': 468}