Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bjoern-hempel/project-analyser

A project analyser that tries to find out some details from the given project path.
https://github.com/bjoern-hempel/project-analyser

apache2 bash contao friends-of-bash html javascript mit-license php project-analyser project-analyzer shell symfony typo3 vhost wordpress

Last synced: 29 days ago
JSON representation

A project analyser that tries to find out some details from the given project path.

Awesome Lists containing this project

README

        

# A project analyser

A project analyser that tries to detect the application type and version number from given web directory.

### A.1) installation

This application uses the friends of bash libraries (https://github.com/bjoern-hempel/friends-of-bash). Check that the libraries are available:

```
user$ friends-of-bash --version
friends-of-bash/v0.0.11
```

If you can see a similar friends of bash version output like above, you can now install this application:

```
user$ sudo -E friends-of-bash install "[email protected]:bjoern-hempel/project-analyser.git"
```

If you don't have installed the friends of bash libraries, please install them first. In short:

```
user$ cd ~ && git clone [email protected]:bjoern-hempel/friends-of-bash.git && cd friends-of-bash
user$ sudo -E bin/install
user$ cd .. && rm -rf friends-of-bash
```

## 1.) Usage

### 1.1) Show the help dialog (`--help`)

```
user$ project-analyser --help

A project analyser (v0.0.15) by Björn Hempel .

Usage: project-analyser [options...] []
-h, --help Shows this help.
-v, --version Shows the version number.

--show-only-app-name Shows only the app name.
--show-only-redirect-url Shows only the redirect url.

--analyse-virtual-hosts Tries to detect the virtual host from given path (needs admin rights).

--show-detailed-w3c-errors Shows w3c errors in detail if available.
--show-number-w3c-errors Shows the number of w3c errors if available.

--write-vhosts-config-file Writes the vhosts config file (needs admin rights).
```

### 1.2) Simply return the app type, version number, file size and count

```
user$ project-analyser /var/www/de/[domain]/[subdomain]/wordpress/html
app: Wordpress
version: 4.7.5
size: 212M
file-count: 3910
```

### 1.3) Only show the application name (`--show-only-app-name`)

```
user$ project-analyser /var/www/de/[domain]/[subdomain]/wordpress/html --show-only-app-name
Wordpress
```

### 1.4) Also try to analyse the virtual hosts (`--analyse-virtual-hosts`)

ATTENTION: This process needs admin rights!

```
user$ sudo project-analyser /var/www/de/[domain]/[subdomain]/wordpress/html --analyse-virtual-hosts
servername: wordpress.[subdomain].[domain].de
app: Wordpress
version: 4.7.5
size: 212M
file-count: 3910
```

## B.) License

MIT © [Björn Hempel](https://www.ixno.de/project-analyser)

Have fun! :)