CLI installation

Install @microsoft/rayfin-cli for a project, verify the version, and keep the CLI aligned with the Rayfin packages in package.json.

Install the Rayfin CLI in the project that owns rayfin/rayfin.yml. A local dev dependency keeps the CLI version aligned with the rest of the Rayfin packages.

Prerequisites

Node.js 20 or later.
npm 10 or later.

New project

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

The create wrapper scaffolds a project and installs @microsoft/rayfin-cli as a dev dependency.

Existing project

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

Run npx rayfin init from the directory that should contain rayfin/rayfin.yml.

Run a specific CLI version without installing

npx @microsoft/rayfin-cli@1.36.2 --version

Inside a project with @microsoft/rayfin-cli installed, prefer npx rayfin <command> so npm resolves the local project version.

Verify the installation

npx rayfin --version
npx rayfin --help

The help output should show the visible 1.36 command groups: init, dev, up, secret, functions, connector, env, login, logout, and docs.

Update the CLI

npm install --save-dev @microsoft/rayfin-cli@latest
npm install
npx rayfin --version

Rayfin packages ship in lockstep. When you update the CLI, update the other @microsoft/rayfin-* dependencies in the same change.

First commands

npx rayfin login
npm run dev
npx rayfin up

npm run dev in bundled templates runs rayfin dev; it does not publish static content.

PromptInstall the Rayfin CLI locally

In my existing TypeScript project, install `@microsoft/rayfin-cli` as a dev dependency,
run `npx rayfin --version`, then run `npx rayfin init` to create rayfin/rayfin.yml with
Auth and Data enabled for Fabric.

Something wrong on this page?Report an issueEdit this page