Install the CLI

The pd4castr CLI is a command-line tool for creating, testing, and publishing forecasting models. You install it once globally and use it across all your model projects.

Prerequisites

You need the following tools installed on your machine:

  • Node.js version 20 or later — the CLI is distributed as an npm package
  • Docker — required for testing and publishing models (the CLI builds and runs Docker containers)

Installation

Install the CLI globally using npm:

npm install -g @pd4castr/cli

You can also use other package managers:

yarn global add @pd4castr/cli
pnpm add -g @pd4castr/cli

Verify the Installation

Run the following command to confirm the CLI is installed:

pd4castr --version

Available Commands

The CLI provides these commands:

CommandDescription
pd4castr initScaffold a new model project from a template
pd4castr loginLog in to the pd4castr platform
pd4castr logoutLog out and clear stored credentials
pd4castr fetchFetch test data from your configured dynamic inputs
pd4castr testBuild and test your model locally
pd4castr publishPublish your model to the platform

Updating

To update to the latest version of the CLI, run:

npm update -g @pd4castr/cli

Next Steps

With the CLI installed, you’re ready to scaffold your first project and log in. Or jump straight to the Quick Start for a guided walkthrough.