/app

Command line application for managing Sqons.

Primary LanguagePHP

Build Status Coverage Status SensioLabsInsight

Sqon

Usage

The following uses a Symfony 3 project as an example. Sqon itself is project agnostic, so it will work on any PHP project regardless of how it is implemented.

First, you will need to create a build configuration file.

# The build configuration settings.
sqon:

    # Enables GZIP compression for all files set.
    compression: GZIP

    # Run the console with the Sqon is executed.
    main: 'bin/console'

    # The paths to set in the Sqon.
    paths: ['.']

    # Name the resulting file "symfony.sqon"
    output: 'symfony.sqon'

    # Make sure the Sqon starts with a shebang line.
    shebang: '#!/usr/bin/env php'

Then, you run the command to create a new Sqon.

$ sqon create

You can use different verbosity levels (i.e. -v, -vv, and -vvv) to more information about the build process. Please note that this can slow down your build time but will not impact the performance of the built Sqon.

When you run php symfony.sqon you will see the Symfony 3 console.

Requirements

  • Current PHP or HHVM long term support release.
    • pdo_sqlite
    • bz2 (if using bzip2 compression)
    • zlib (if using gzip compression)

Install

You will need to download the executable from the releases page.

This project is intentionally not available on Packagist. This library requirements for this project may conflict with other requirements for your project. By using a standalone application, these conflicts are avoided.

Documentation

All of the documentation has been written into the commands themselves. To access this documentation, please run the desired command followed by the -h or --help option:

$ ./sqon create -h

GPG Signature

You can download Kevin Herrera's public key and verify the signature (sqon.sig) of sqon.

gpg --keyserver hkp://pgp.mit.edu --recv-keys 41515FE8
gpg --verify sqon.sig sqon

License

This project is released under both the MIT and Apache 2.0 licenses.

Logo

The scone in the logo was created by anbileru adaleru from the Noun Project.