View Source mix antikythera.gear.new (antikythera v0.5.1)

Generates a mix project for a new gear application.

Usage

This mix task must be run from a mix project directory of either your antikythera instance or one of gears in your antikythera instance.

mix antikythera.gear.new PATH

Basename of PATH becomes the name of your gear. For example, if ~/workspace/my_gear is used, my_gear becomes your gear name.

Newly generated gear automatically belongs to an antikythera instance inferred from the mix project you are currently in.

You can also manually specify your antikythera instance via ANTIKYTHERA_INSTANCE_DEP environment variable like so:

ANTIKYTHERA_INSTANCE_DEP='{:instance_name, [git: "git@github.com:your-organization/instance_name.git"]}' mix antikythera.gear.new PATH

ANTIKYTHERA_INSTANCE_DEP must be a valid dependency tuple used in mix.exs files. See mix deps doc for available options.

In order to sync development environment configurations with your antikythera instance and other gears, this generator creates symbolic links to these files, if they exist in the current directory:

  • .credo.exs
    • Configuration file for static code analysis tool Credo
  • .tool-versions
    • Local versions file for version manager tool asdf

Summary

Functions

run(args)

Callback implementation for Mix.Task.run/1.

Functions

Link to this function

run(args)

View Source

Callback implementation for Mix.Task.run/1.