View Source mix skitter.new (Skitter v0.7.1)

Create a Skitter project. It expects the path of the project as an argument.

$ mix skitter.new PATH [--module MODULE] [--no-fetch-deps] [--fetch-deps] [--develop]

This task creates a new Skitter project, similar to mix new and mix phx.new. The project is created at PATH and is set up to allow the use of Skitter.

Specifically, the generated project will contain the following files:

  • a mix.exs file which declares Skitter as a dependency and which is set up to build a Skitter release.

  • a config/config.exs file which provides some initial configuration for Skitter and logging.

  • a lib/MODULE.ex file which contain an empty workflow to get started.

  • a .formatter.exs file which sets up mix format

  • a .iex.exs file which auto-imports Skitter when starting iex.

  • a README.md file which documents the project layout.

  • a .gitignore file.

After setting up the project file, this task will fetch the project dependencies if required.

Flags and arguments

  • --develop: use the latest development version of Skitter (from github) instead of the current stable version (from hex.pm).

  • --module MODULE: specify the name of the generated module. If this is not provided, a name is generated based on PATH.

  • --(no-)deps: By default, the installer asks the user if it should run mix deps.get and mix deps.compile after creating the project. Set this flag to skip this prompt and to explicitly opt in or out of automatically running these commands.