Installation

Learn how to install and set up Autorun

Get started with Autorun by following this comprehensive installation guide.

Prerequisites

Before you begin, ensure you have the following installed:

Important

Make sure you have administrative privileges to install packages globally.

Install the Autorun CLI globally using npm:

npm install -g @autorun/cli

Or using yarn:

yarn global add @autorun/cli

Check that the installation was successful:

autorun --version

You should see the current version number displayed.

Here's a quick video tutorial showing the installation process:

After installation, initialize your first project:

autorun init my-first-project
cd my-first-project

This will create a new directory with the basic project structure:

my-first-project/
├── autorun.config.js
├── workflows/
│   └── example.yaml
└── README.md

Your project is now set up! Continue to the Quick Start Guide to create your first workflow.

If you encounter any issues during installation:

Permission Errors: Try using sudo on macOS/Linux or run your terminal as Administrator on Windows
Network Issues: Check your internet connection and npm registry settings
Version Conflicts: Make sure you're using a compatible Node.js version

Need Help?

Join our Discord community or check out our FAQ.