Install the Skedulo CLI

How to download and install the Skedulo CLI.

Overview

The Skedulo CLI is a command line interface tool that enables developers to easily build, test, and deploy custom solutions on Skedulo. It is supported for both Skedulo Pulse and Skedulo for Salesforce customers, however the specific support for each platform is determined by the commands and artifacts you are interacting with.

Operating systems

Skedulo CLI is supported on the following operating systems:

macOS 10.15 and above (Apple Silicon and Intel)
Windows 10 or later (32 or 64bit)

API permission

Skedulo CLI requires API Enabled system permission, which provides programmatic access to your organization’s information. If you’re unable to run CLI commands, ask your Skedulo administrator to enable this permission.

Installation methods

We provide installers for macOS and Windows.

macOS installer

Download Skedulo CLI installer for either Apple Silicon or Intel versions of macOS.
Locate the file in the browser’s download folder.
Launch the installer and follow the on-screen instructions to install the Skedulo CLI.
After installation, close and re-open any terminal windows to ensure the CLI is available.

Windows installer

Download Skedulo CLI installer for either 64bit or 32 bit versions of Windows.
Locate the file in the browser’s download folder.
Launch the installer and follow the on-screen instructions to install the Skedulo CLI.
After installation, close and re-open any command prompt or powershell windows to ensure the CLI is available.

Important

We recommend using either the command prompt (cmd.exe) or PowerShell to use the CLI. Using it under WSL or similar is not supported.

Verify the installation

After installation is complete, verify it has been correctly installed by running the following command in your terminal or command prompt:

sked about

This will confirm the CLI has installed correctly and show you the version you are currently using.

The Skedulo CLI about screen

Update the Skedulo CLI

The Skedulo CLI gets updated regularly and it’s important to be on the latest version to ensure you have any new fixes and features.

To update the CLI to the latest version, run this command:

sked update

You can always check which version of the Skedulo CLI you are running by running:

sked about

Uninstalling the Skedulo CLI

To uninstall the Skedulo CLI, use the following commands, depending on your system.

macOS

sudo rm -rf /usr/local/lib/sked
sudo rm -rf /usr/local/bin/sked
sudo rm -rf ~/.local/share/sked
sudo rm -rf ~/Library/Caches/sked
sudo rm -rf ~/.config/sked