clamp - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #go #golang #machine-learning #deep-learning #macos #nodejs #awesome #security #pytorch #openai #open-source

clamp

(★ 78)

Command Line Apache MySQL PHP

File Explorer

Download Latest Version (.zip)

- - ApacheCommand.php
  - Command.php
  - ConfigCommand.php
  - ConfigOptionsParser.php
  - HelpCommand.php
  - HostCommand.php
  - MysqlCommand.php
  - StartCommand.php
  - StopCommand.php
- - .travis.yml
  - composer.json
  - example.php
  - LICENSE
  - phpunit.xml.dist
  - README.md
- - JsonPath.php
.gitignore
.travis.yml
CHANGELOG.md
clamp
clamp.defaults.13.json
clamp.defaults.json
clamp.php
integration_test.sh
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/jide/clamp

Downloads the entire project code from GitHub to your computer.

cd clamp

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

cd includes/ConsoleKit

This project's files live in a subfolder, so move into it first.

composer install

Installs the PHP libraries listed in composer.json.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Clamp
=====

### [<span class="octicon octicon-link"></span>](#welcome-to-clamp) Welcome to Clamp

Clamp is a Command Line Apache MySQL PHP for Mac OS X made for local development. It aims at being ultra simple to use and configure.

*   Automatically creates a host and a database.
*   Uses system's Apache and PHP, and MariaDB using homebrew.
*   System-wide configuration remains unchanged.
*   All data are self contained in a `.clamp` folder.
*   Configuration is done using a `clamp.json` JSON file.

<span class="octicon octicon-alert"></span> It should **only** be used for local development. It is absolutely not secure for anything else.

### [<span class="octicon octicon-link"></span>](#installation) Installation

```
$ brew tap jide/clamp
$ brew install clamp
```

You must have [homebrew](http://brew.sh) installed.

### [<span class="octicon octicon-link"></span>](#installation) OS X Yosemite

Since in Yosemite Apache version is 2.4, you may have to correct your .htaccess file :

```
  Order allow,deny
```

Becomes :

```
  <IfModule mod_authz_core.c>
    Require all denied
  </IfModule>
  <IfModule !mod_authz_core.c>
    Order allow,deny
  </IfModule>
```

### [<span class="octicon octicon-link"></span>](#quickstart) Usage

To serve the current folder :

```
$ clamp
```

Use <kbd>Ctrl</kbd> + <kbd>C</kbd> to exit.

By default, this will start apache, create a database named "db", start MySQL daemon and set the host as "localhost". You can customize these settings using the [configuration](#configuration) file.

You can connect to MySQL through localhost:3306 with user "root" and a blank password. [Sequel Ace](https://sequel-ace.com/) is a great app for managing your databases.

### [<span class="octicon octicon-link"></span>](#all-commands) All commands

```
$ clamp apache start // Start apache.
$ clamp apache stop // Stop apache.

$ clamp mysql start // Install database, start daemon and create db.
$ clamp mysql stop // Shortcut for mysql daemon stop.
$ clamp mysql daemon start // Start mysql daemon.
$ clamp mysql daemon stop // Stop mysql daemon.
$ clamp mysql install // Install.
$ clamp mysql create-db [database] // Create a database.
$ clamp mysql export [database?] [file?] // Export databases.
$ clamp mysql import [file?] [database?] // Import SQL file.

$ clamp host set [host] // Add a host.
$ clamp host unset [host] // Remove a host.

$ clamp config write // Writes the default clamp.json file in the current folder.
```

### [<span class="octicon octicon-link"></span>](#configuration) Configuration

All configuration resides in a clamp.json file. All the parameters are built using this file and then passed to the different commands. It uses a few tricks that make it very flexible.

To copy the default configuration file in the current directory, use `clamp config write`.

A simple configuration :

```json
{
    "address": "localhost",
    "memory": "256M",
    "database": "db",
}
```

You can also configure each command and their options :

```json
{
    "apache": {
        "commands": {},
        "options": {}
    },
    "host": {
        "options": {}
    },
    "mysql": {
        "commands": {},
        "databases": [],
        "options": {}
    },
    "php": {
        "options": {}
    }
}
```

See the [default configuration file](https://github.com/jide/clamp/blob/master/clamp.defaults.json) for a detailed view of the options.

You can insert the current working direcory :

```json
"errorlog": "'{{$cwd}}/.clamp/logs/apache.error.log'"
```

You can even use a path to another option :

```json
{
    "php": {
        "options": {
            "memory_limit": "{{$.memory}}",
            "pdo_mysql.default_socket": "{{$.mysql.options.socket}}",
            "mysql.default_socket": "{{$.mysql.options.socket}}",
            "mysqli.default_socket": "{{$.mysql.options.socket}}"
        }
    }
}
```

### [<span class="octicon octicon-link"></span>](#file-structure) File structure

Everything is self-contained in a `.clamp` folder inside your project: The database files, the logs and the socket / PID files.

```
.clamp
  - data // The database files
  - logs // Apache and MySQL logs
  - tmp // PID files and sockets
```

Note that this is the default configuration. But since you can define these paths in the configuration file, you are free to use a completly different structure.