Scotty Laravel Package

title: Running tasks weight: 4

Running a task or macro

scotty run deploy
scotty run cloneRepository

Scotty shows each task as it runs, with a step counter, elapsed time, and the command that's currently executing:

If a task fails, Scotty shows the output and stops. You'll immediately see what went wrong:

Pretend mode

Want to see what would happen without actually running anything? Use --pretend:

scotty run deploy --pretend

This shows the SSH commands Scotty would execute, without connecting to any server.

Continue on failure

By default, Scotty stops at the first failed task. If you want it to keep going regardless:

scotty run deploy --continue

Summary mode

If you don't need to see all the output and just want to know whether things passed:

scotty run deploy --summary

This hides task output and only shows results. Failed tasks always show their output, even in summary mode.

Dynamic options

You can pass custom variables from the command line:

scotty run deploy --branch=develop

In the Scotty.sh format, --branch=develop becomes $BRANCH. The key is uppercased and dashes become underscores.

In the Blade format, it becomes available as $branch.

Pause and resume

Sometimes you want to take a quick look at the server halfway through a deploy, or you just want to slow things down and watch each step more carefully. Press p at any point during execution. Scotty finishes the current task and then waits.

Press Enter to continue with the next task, or Ctrl+C if you want to stop entirely.

Cancelling

You can press Ctrl+C at any time to cancel. Scotty restores the terminal and exits cleanly. Everything that was already output stays in your scrollback, so you can scroll up to see what happened.

Listing tasks

To see all available tasks and macros in your file:

scotty tasks

SSH into a server

You can quickly SSH into any server defined in your Scotty file:

scotty ssh
scotty ssh remote

If only one server is defined, Scotty connects to it directly. With multiple servers, you'll get a selection prompt.

Creating a new file

scotty init

This prompts you to choose a format (bash or Blade) and a server host, then creates the file for you.