mix quenya.new (QuenyaInstaller v0.3.3) View Source

Creates a new Quenya project.

It expects the path of the project as an argument.

mix quenya.new SPEC PATH [--module MODULE] [--app APP]

A project at the given PATH will be created based on the spec. The application name and module name will be retrieved from the path, unless --module or --app is given.

Options

  • --umbrella - generate an umbrella project, with one application for your domain, and a second application for the web interface.

  • --app - the name of the OTP application

  • --module - the name of the base module in the generated skeleton

  • --verbose - use verbose output

Installation

mix quenya.new by default prompts you to fetch and install your dependencies. You can enable this behaviour by passing the --install flag or disable it with the --no-install flag.

Examples

mix quenya.new todo.yml todo

Is equivalent to:

mix quenya.new todo.yml todo --module Todo

As an umbrella:

mix quenya.new todo.yml todo --umbrella

Would generate the following directory structure and modules:

todo_umbrella/   Todo.Umbrella
  apps/
    todo/        todo app

You can read more about umbrella projects using the official Elixir guide

To print the Quenya installer version, pass -v or --version, for example:

mix quenya.new -v

Link to this section Summary

Link to this section Functions

Link to this function

generate(filename, base_path, generator, path, opts)

View Source

Callback implementation for Mix.Task.run/1.

Link to this function

run(argv, generator, path)

View Source