mix workspace.new (WorkspaceNew v0.2.0)

View Source

Creates a new workspace project.

It expects the path of the project as an argument.

$ mix workspace.new PATH [--module MODULE] [--app APP]

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

Options

  • --app - the name of the workspace

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

In most cases you will not need to pass any options.

Examples 

$ mix workspace.new my_workspace

Would generate the following structure:

my_workspace
├── .formatter.exs
├── .gitignore
├── .workspace.exs
├── README.md
└── mix.exs

You can now add normal mix projects within your workspace using the mix new command and update your workspace config by editing the .workspace.exs configuration file.

For more details check the Workspace docs.