Project Information

Display comprehensive information about your NestJS project including dependencies, versions, system information, and project configuration. The info command provides a detailed overview of your development environment and project setup.

Capabilities

Info Command

Displays detailed project and system information in a formatted, easy-to-read layout.

# Display project information
nest info [options]
nest i [options]

# Options:
-h, --help                          # Output usage information

Usage Examples:

# Display full project information
nest info

# Using alias
nest i

# Get help for info command
nest info --help

Information Categories

System Information

The command displays comprehensive system details:

# System Information Output:
[System Information]
OS Version     : Linux 5.4.0
NodeJS Version : v18.17.0
YARN Version   : 1.22.19
NPM Version    : 9.8.1

[Nest CLI]
Nest CLI Version : 10.1.0

[Nest Platform Information]
platform-express version : 10.1.0
platform-fastify version : Not Found
platform-socket.io version : Not Found
platform-ws version : Not Found

NestJS Ecosystem

Information about installed NestJS packages and their versions:

# NestJS Package Versions:
@nestjs/core version         : 10.1.0
@nestjs/common version       : 10.1.0
@nestjs/microservices version: 10.1.0
@nestjs/websockets version   : 10.1.0
@nestjs/testing version      : 10.1.0
@nestjs/platform-express version: 10.1.0
@nestjs/cli version          : 10.1.0
@nestjs/schematics version   : 10.0.2

Development Dependencies

Information about key development tools and their versions:

# Development Tools:
TypeScript version : 5.1.6
Webpack version    : 5.88.0
Jest version       : 29.6.0
Prettier version   : 3.0.0
ESLint version     : 8.44.0

Project Configuration

Details about the current project setup:

# Project Configuration:
Nest CLI Configuration:
  Source Root: src
  Collection: @nestjs/schematics
  Entry File: main

Output Format

Formatted Display

The command uses a clean, organized format with:

• Section headers in brackets
• Aligned key-value pairs
• Version information clearly displayed
• Color-coded output for better readability

Table Format

Some information is displayed in table format for better organization:

┌─────────────────────────┬─────────────────────────┐
│ Package                 │ Version                 │
├─────────────────────────┼─────────────────────────┤
│ @nestjs/core           │ ^10.1.0                 │
│ @nestjs/common         │ ^10.1.0                 │
│ @nestjs/platform-express│ ^10.1.0                │
└─────────────────────────┴─────────────────────────┘

Use Cases

Environment Verification

Quickly verify your development environment setup:

# Check if all required tools are installed
nest info

# Verify specific version requirements
# Useful before starting development or deployment

Troubleshooting

Gather system information for bug reports and support:

# Collect information for GitHub issues
nest info > system-info.txt

# Share environment details with team members
# Useful for debugging environment-specific issues

Project Auditing

Audit project dependencies and versions:

# Check for outdated packages
nest info

# Verify consistent versions across environments
# Useful during project maintenance

Dependency Detection

Automatic Discovery

The command automatically detects:

• Installed NestJS packages and their versions
• Development tools (TypeScript, Webpack, Jest, etc.)
• System information (OS, Node.js version)
• Package managers (npm, yarn, pnpm)

Missing Dependencies

When dependencies are not found:

# Example output for missing packages:
@nestjs/graphql version : Not Found
@nestjs/typeorm version : Not Found
Webpack version         : Not Found

Project Structure Analysis

Monorepo Support

For monorepo projects, the command shows:

• Root-level dependencies
• CLI configuration for the workspace
• Global tool versions
• Individual project configurations

Configuration Files

The command reads and displays information from:

• package.json - for dependency versions
• nest-cli.json - for CLI configuration
• tsconfig.json - for TypeScript settings
• angular.json - for workspace configuration (if present)

Integration with CI/CD

Automated Environment Checks

# In CI/CD pipelines
nest info
# Use exit code to verify required tools are present
# Include in deployment scripts for environment validation

Version Consistency

# Check version consistency across environments
nest info | grep "@nestjs/core"
# Useful for ensuring production matches development versions

Output Customization

Environment Variables

The command respects environment variables:

• NODE_ENV - affects some package detection
• NPM_CONFIG_PREFIX - for global package locations
• Package manager specific configurations

JSON Output

While not built-in, you can process the output for programmatic use:

# Parse specific information
nest info | grep "NodeJS Version" | cut -d: -f2
nest info | grep "@nestjs/core" | cut -d: -f2

Common Information Displayed

Runtime Environment

• Operating System version and architecture
• Node.js version and installation path
• Package manager versions (npm, yarn, pnpm)
• Global CLI tool versions

NestJS Ecosystem

• Core framework packages
• Platform adapters (Express, Fastify)
• Add-on packages (GraphQL, TypeORM, etc.)
• Development and testing tools

Build Tools

• TypeScript compiler version
• Build system tools (Webpack, SWC)
• Testing frameworks (Jest, etc.)
• Code quality tools (ESLint, Prettier)

Project Metadata

• CLI configuration settings
• Source root directory
• Default schematics collection
• Entry file configuration

Troubleshooting Common Issues

Version Mismatches

The command helps identify:

• Incompatible package versions
• Missing peer dependencies
• Outdated CLI versions
• Conflicting tool versions

Environment Problems

Diagnose environment issues:

• Node.js version compatibility
• Package manager configuration
• Global vs. local installations
• Path and permission issues