Fluid Analytics CLI

A command-line tool for analyzing the usage of the Fluid Design System globally.

Features

• Scan your GitHub repository or organization to analyze:
  • Fluid versions
  • Component usage

Usage

Install the package globally and run the CLI:

npm install -g @engie-group/fluid-analytics
fluid-analytics <command>

Or run directly with npx:

npx @engie-group/fluid-analytics <command>

Command: repositories

This command requires the following environment variables:

• API_GITHUB_AUTH_TOKEN: Personal access token (classic) for GitHub API calls
• API_GITHUB_BASE_URL: GitHub API URL (may vary for GitHub Enterprise Server)
• REPOSITORIES_TARGET_ORG: GitHub organization to scan (when no --repository parameter is provided)
• REPOSITORIES_CURRENT_REPO: GitHub repository to exclude from scanning (if any)

Basic Scan

Scan a specific repository:

fluid-analytics repositories --repository <repository-name>

Repository name format should be: <orgnaization name>/<repository name>

Scan a GitHub organization:

fluid-analytics repositories

Select report output filename

Specify a filename for the report output:

fluid-analytics repositories --output <json-filename>

Filename should end with .json

Contributing

We do not yet accept contributions. Please contact us if you have any bugs or feature requests.

License

MIT