Install the Skedulo CLI for mobile extensions

Install dependencies and tools for creating Skedulo Plus extensions.

Overview

The Skedulo CLI is a command-line tool that provides a set of commands to help you build and publish your Skedulo Plus extension.

This section provides instructions for downloading and installing the Skedulo CLI, and using it to publish your extension.

Install the Skedulo CLI

Install the Skedulo CLI for Mac

For Mac users, the installer is available as either arm64.pkg or x64.pkg depending on the type of Mac you are using. To determine which installer to use, run the following command in the terminal:

uname -m

This command will return either arm64 or x86_64 depending on your system architecture.

  1. Download the installer for your system from the provided folder.

  2. Open the installer and follow the on-screen instructions to install the Skedulo CLI.

  3. Verify the installation by running the following command in the terminal:

    sked --version
    

    The terminal should display the version number of the Skedulo CLI.

Install the Skedulo CLI for Windows

For Windows users, the installer is available as x64.exe or x86.exe depending on your system architecture. To determine which installer to use, right-click on the Windows icon in the taskbar and select System. The system type will be displayed under Device specifications.

Alternatively, you can run the following command in the command prompt:

wmic os get osarchitecture

This command will return either 64-bit or 32-bit, corresponding to x64 and x86 respectively.

  1. Download the installer for your system from the provided folder.

  2. Open the installer and follow the on-screen instructions to install the Skedulo CLI.

  3. Verify the installation by running the following command in the command prompt:

    sked --version
    

    The command prompt should display the version number of the Skedulo CLI.

Log in to your Skedulo account

Before you can publish your Skedulo Plus extension, you must log in to your Skedulo account using the Skedulo CLI.

You can log in using either the web-based login or using an access token (API key).

Web-based login

To log in using the web, you must know the name and environment of the team to which you want to publish the extension. These can be passed as flags on the command line, or you will be prompted when you run the command.

Run the following command to log in to your Skedulo account:

sked tenant login web --tenant-name {teamname} --environment {test/dev/prod/etc} --alias {teamname}

If your team has multiple login options, you will be prompted to select the login option you want to use. The browser will open and prompt you to log in to your Skedulo account.

Access token login

To log in using an access token, you must have an access token (API key) for your Skedulo account and know the team environment type. If you don’t provide these as flags you will be prompted for them.

Run the following command to log in to your Skedulo account using an access token:

sked tenant login access-token --environment {production/test/dev} --alias {mytenant}

You will be prompted to enter your access token.