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

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"

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

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 "anaylze" command success');
  // you can stop the Rsdoctor's dev-server by calling the sdk'api below:
  // sdk.dispose();
});