#CLI tutorial

We provide @rsdoctor/cli for you to use Rsdoctor's features locally through the CLI program.

#Install @rsdoctor/cli

npm add @rsdoctor/cli -D

yarn add @rsdoctor/cli -D

pnpm add @rsdoctor/cli -D

bun add @rsdoctor/cli -D

deno add npm:@rsdoctor/cli -D

#Command usage

rsdoctor <command> [options]

@rsdoctor/cli currently provides the following commands for different functionalities:

#analyze command

The analyze command is mainly used to load the manifest.json file locally and start Rsdoctor's analysis report page without the need to rebuild.

rsdoctor analyze --profile <manifestFile>

Parameter Definition

• manifestFile is the path to the manifest.json file (supports local path)

Usage Example

rsdoctor analyze --profile "./dist/.rsdoctor/manifest.json"

#bundle-diff command

The bundle-diff command loads two manifest.json files locally and compares their build bundles. By default, it opens the Rsdoctor Bundle Diff page in the browser. Use --json [path] to generate a JSON report without starting the report server or opening the browser.

rsdoctor bundle-diff --baseline <baselineManifestJsonPath> --current <currentManifestJsonPath>

Parameter definitions

• --baseline <path>: Path or online URL of the manifest.json used as the baseline.
• --current <path>: Path or online URL of the manifest.json used as the current build.
• --json [path]: Generate a JSON diff report. The default output path is rsdoctor-diff.json.

Open the report in the browser

rsdoctor bundle-diff --baseline="baseline/.rsdoctor/manifest.json" --current="current/.rsdoctor/manifest.json"

Generate a JSON report

rsdoctor bundle-diff \
  --baseline="baseline/.rsdoctor/manifest.json" \
  --current="current/.rsdoctor/manifest.json" \
  --json="result.json"

The JSON report contains diff data for assets, modules, and packages. You can consume it in CI workflows or use it to generate pull request comments.

#Node API

We provide a Node.js API in @rsdoctor/cli that allows you to make calls during runtime in Node.js.

Importing the Module

import { execute } from '@rsdoctor/cli';

const { execute } = require('@rsdoctor/cli');

execute()

The execute asynchronous function is the execution function of Rsdoctor CLI. By calling the execute function, it will automatically parse process.argv and invoke different commands.

execute('analyze', {...})

If you need to directly execute the analyze command through the Node.js API, you can call it as follows:

execute('analyze', {
  profile: 'input the manifest.json path or url',
}).then((sdk) => {
  console.log('execute "analyze" command success');
  // you can stop the Rsdoctor's dev-server by calling the sdk'api below:
  // sdk.dispose();
});