Xamal.AppTasks (xamal v0.3.0)

Copy Markdown View Source

Application task implementations.

Summary

Functions

Opens an interactive remote IEx session connected to the running release.

Runs the release migrator on the selected hosts.

Opens an interactive remote shell (IEx) connected to the running release.

Lists releases that would be removed by pruning (a read-only preview).

Starts the systemd service on the currently active port without a full boot.

Prints the current release version on the selected hosts.

Functions

boot(args, opts, context)

exec(args, opts, context)

iex(args, opts, context)

Opens an interactive remote IEx session connected to the running release.

Alias of shell/3; both connect via the release's remote command.

live(args, opts, context)

logs(args, opts, context)

maintenance(args, opts, context)

migrate(args, opts, context)

Runs the release migrator on the selected hosts.

Calls <AppModule>.Release.migrate() via the release's RPC, following the conventional mix phx.gen.release-style Release module. Override the module by passing it as an argument, e.g. mix xamal.migrate MyApp.Release.

shell(args, opts, context)

Opens an interactive remote shell (IEx) connected to the running release.

Convenience wrapper for mix xamal.app.exec -i.

stale_releases(args, opts, context)

Lists releases that would be removed by pruning (a read-only preview).

mix xamal.prune performs the actual removal.

start(args, opts, context)

Starts the systemd service on the currently active port without a full boot.

Use this to bring an app back up after mix xamal.app.stop; mix xamal.app.boot performs the heavier zero-downtime swap instead.

stop(args, opts, context)

version(args, opts, context)

Prints the current release version on the selected hosts.

See also mix xamal.versions, which lists every release and marks the current one.