Installation

Install Node.js 20+ and the GitHub CLI on Windows, macOS, or Linux, then verify and update the Rayfin CLI.

Rayfin needs the same prerequisites whether you're scaffolding a new project or deploying to Microsoft Fabric: Node.js 20 or later and the GitHub CLI. Install these before you scaffold a project.

Windows

Install the latest LTS Node.js:

winget install -e --id OpenJS.NodeJS.LTS

Install the GitHub CLI:

winget install --id GitHub.cli -e

Add it to PATH if it is not already there:

where gh
# If there are no results, add the GitHub CLI to your PATH:
$env:PATH += ";C:\Program Files\GitHub CLI"; [Environment]::SetEnvironmentVariable("PATH", $env:PATH, "User")

gh auth login
node --version
gh --version

Note

If prompted during gh auth login, authorize GitHub to access Microsoft.

macOS

brew install node@lts
brew install gh

Verify the GitHub CLI is on PATH, sign in, and check versions:

which gh
gh auth login
node --version
gh --version

Note

If prompted during gh auth login, authorize GitHub to access Microsoft.

Linux (Ubuntu or Debian)

Install the latest LTS Node.js using the official Node.js download instructions.

Install the GitHub CLI:

type -p curl >/dev/null || sudo apt install -y curl
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
sudo apt update
sudo apt install -y gh

Verify the GitHub CLI is on PATH, sign in, and check versions:

which gh
gh auth login
node --version
gh --version

Install the Rayfin CLI

You do not usually install @microsoft/rayfin-cli directly — scaffolding a project installs it for you as a dev dependency.

New project:

npm create @microsoft/rayfin@latest my-app
cd my-app

Existing project — install the CLI, then run the interactive setup to create the rayfin/ directory with starter configuration files:

npm install --save-dev @microsoft/rayfin-cli
npx rayfin init

Verify the installation

npx rayfin --version

List every available command:

npx rayfin --help

Update the CLI

npm update --save
npm install

Confirm the update:

npx rayfin --version

PromptInstall Rayfin's prerequisites

Check whether this machine has Node.js 20 or later and the GitHub CLI installed, and
install or update whichever are missing for this operating system. Then run `gh auth
login` to sign in, and print the output of `node --version` and `gh --version` so I can
confirm everything is ready before I scaffold a Rayfin project.

Quickstart — scaffold your first project.
Project structure — what the scaffold generates.
CLI installation reference — every install-related command and flag.

Something wrong on this page?Report an issueEdit this page