Cortex is the intelligent coding assistant for Elixir.
- Compiles and reloads modified files
- Automatically runs the appropriate tests at the appropriate time
- Accepts pluggable adapters for custom builds
Getting started with Cortex is easy. Add the following to your mix.exs file:
def deps do
[
{:cortex, "~> 0.1", only: [:dev, :test]},
]
endIf you're running an umbrella application, add Cortex to the dependencies of
each of the sub-apps that you would like Cortex to monitor. Do this instead
of adding it as a dependency in the root mix.exs file.
This is necessary because dependencies in the root mix.exs in umbrella
application are not automatically started, which is a process that Cortex
depends on.
Cortex runs automatically along-side your mix app.
iex -S mixThis is enough to get live-reload on file change when editing your app.
If you are running a phoenix application, make sure you are running the app in interactive mode:
iex -S mix phoenix.serverWhen you run your app with MIX_ENV=test,
Cortex will automatically run tests for saved test files,
as well as tests paired with saved files in lib.
MIX_ENV=test iex -S mixWhether cortex runs at all can be configured via the configuration of your application. By default cortex does run.
config :cortex,
enabled: falseCortex also supports the Elixir / Erlang convention of a
{:system, ENV_VAR_NAME, default_value} in the config file.
For example, if you wanted to have cortex disabled in your project by default,
you could add the following to your config.exs:
config :cortex,
enabled: {:system, "CORTEX_ENABLED", false}Then, to run cortex you would start iex with the following options:
CORTEX_ENABLED=true iex -S mix
- Reload Modules
- Rerun tests
- Credo runner
- Dialyzer runner
- ExDash runner
- Custom mix task runner
- Cortex 'focus' mode
- Broader OTP reload support
This software is licensed under the MIT license.

