@pagopa/dx-cli

📖 Overview

The DX CLI is a command-line tool designed to help developers manage and validate their development setup according to PagoPA's DevEx guidelines. It provides automated checks and validations to ensure repositories follow the established best practices and conventions.

✨ Features

- Repository Validation: Verify repository setup against DevEx guidelines with the doctor command
- Code Migrations: Apply automated migration scripts (codemods) to update code and configurations
- Project Initialization: Bootstrap new monorepo projects with standardized structure
- Cost Optimization: Analyze Azure subscriptions to identify unused or underutilized resources
- Project Information: Display comprehensive information about your project setup and tools
- Developer Experience Optimization: Ensure consistent development practices across projects

🚀 Installation

Install the CLI globally using your preferred package manager:

``bash


Using npm

npm install -g @pagopa/dx-cli

Using yarn

yarn global add @pagopa/dx-cli

Using pnpm

pnpm add -g @pagopa/dx-cli
`

$3

`bash


Clone the repository

git clone https://github.com/pagopa/dx.git
cd dx

Install dependencies (using npm)

npm install

Or using yarn

yarn install

Or using pnpm

pnpm install

Build the CLI

npm run build

Or: yarn build

Or: pnpm build

Run the CLI

node ./apps/cli/bin/index.js --help
`

🛠️ Usage

$3

#### doctor

Verify the repository setup according to the DevEx guidelines.

`bash
dx doctor
`

This command will:

- Check if you're in a valid Git repository
- Validate that required monorepo scripts are present in package.json
- Check that the turbo.json file exists
- Verify that the installed turbo version meets the minimum requirements

Example output:

`bash
$ dx doctor
Checking monorepo scripts...
✅ Monorepo scripts are correctly set up
`

#### codemod

Manage and apply migration scripts (codemods) to the repository.

`bash


List available codemods

dx codemod list

Apply a specific codemod by ID

dx codemod apply
`

This command helps you:

- View all available migration scripts for your repository
- Apply automated code transformations to keep your codebase up to date
- Migrate configurations and code patterns to newer standards

#### init

Bootstrap a new monorepo project with standardized structure and remote repository provisioning.

`bash
dx init project
`

This command will:

- Check that required tools (e.g., Terraform CLI) are installed
- Interactively prompt for project metadata (cloud provider, region, environments, cost center, etc.)
- Check that the target GitHub repository does not already exist before proceeding
- Generate a monorepo structure following PagoPA DevEx guidelines
- Create a remote GitHub repository using Terraform
- Push the initial codebase to the newly created repository

If the specified GitHub repository already exists, the command will fail early with a clear error message, preventing accidental overwrites.

Example usage:

`bash
$ dx init project
? What is the repository name? my-monorepo
? What is the GitHub repository owner? pagopa
? What is the repository description? My new PagoPA monorepo
...

✔ Terraform CLI is installed!
✔ Workspace files created successfully!
✔ GitHub repository created successfully!
✔ Code pushed to GitHub successfully!

Workspace created successfully!
- Name: my-monorepo
- Cloud Service Provider: azure
- CSP location: italynorth
- GitHub Repository: https://github.com/pagopa/my-monorepo
`

> [!NOTE]
> The command will fail early if required tools are missing.

#### info

Display comprehensive information about your project setup and tools.

`bash
dx info
`

This command provides:

- Current project configuration details
- Installed tool versions
- Repository metadata
- Development environment information

#### savemoney

Analyze Azure subscriptions to identify unused or underutilized resources that could be costing you money.

`bash
dx savemoney [options]
`

Options:

| Option | Alias | Description | Default |
| :----------- | :---- | :-------------------------------------------------------------------- | :----------- |
| --config | -c | Path to a JSON configuration file. | N/A |
| --format | -f | Report format (table, json, detailed-json). | table |
| --days | -d | Metric analysis period in days. | 30 |
| --location | -l | Preferred Azure location for resources. | italynorth |
| --verbose | -v | Enable verbose mode with detailed logging for each resource analyzed. | false |

Example usage:

`bash


Analyze with default settings (interactive prompts)

dx savemoney

Use a configuration file

dx savemoney --config config.json

Output as JSON with verbose logging

dx savemoney --format json --verbose

Analyze with specific timespan

dx savemoney --days 60 --location italynorth
`

Configuration file example (config.json):

`json
{
"tenantId": "your-tenant-id",
"subscriptionIds": ["subscription-1", "subscription-2"],
"preferredLocation": "italynorth",
"timespanDays": 30
}
`

Analyzed Azure resources:

- Virtual Machines: Deallocated or stopped VMs, low CPU usage
- Managed Disks: Unattached disks
- Network Interfaces: Unattached NICs
- Public IP Addresses: Unassociated static IPs
- Storage Accounts: Low transaction counts
- App Service Plans: Empty plans or oversized tiers
- Private Endpoints: Unused or misconfigured endpoints
- Container Apps: Not running, zero replicas, low resource usage
- Static Web Apps: No traffic or very low usage patterns

> [!NOTE]
> Currently only Azure is supported. Support for additional cloud providers (AWS) is planned for future releases.

$3

- --version, -V: Display version number
- --help, -h`: Display help information

---