Getting Started

Getting Started with pjt

pjt is a powerful cross-platform CLI tool. It removes empty directories, ignored files, and reinstalls dependencies with support for npm, pnpm, and yarn.

Prerequisites

• Node.js >= 18.0.0
• Git repository

Installation

Install pjt globally using your favorite package manager:

npm

npm install -g pjt

pnpm

pnpm add -g pjt

yarn

yarn global add pjt

Verify installation

After installation, check if pjt is available:

pjt --version

Basic Usage

Navigate to your Git repository and run:

pjt

This command will:

• Remove empty directories
• Remove files ignored by .gitignore
• Reinstall dependencies based on your package manager

What does pjt do exactly?

When you run pjt, the tool executes the following steps:

1. Package manager detection: Automatically detects if you use npm, pnpm or yarn
2. Empty directory cleaning: Recursively removes all empty folders
3. Ignored files cleaning: Removes files and folders listed in .gitignore
4. Dependency reinstallation: Cleans node_modules and reinstalls all dependencies

Example output

🔍 Detected package manager: pnpm
🗂️ Removed 3 empty directories
🚫 Removed 12 ignored files
📦 Reinstalling dependencies...
✅ Done! Repository is clean.

Advanced usage

With options

# Clean only, without reinstallation
pjt --clean-only

# Verbose mode for more detailed output
pjt --verbose

# Help
pjt --help

In CI/CD pipeline

Add pjt to your CI/CD process:

.github/workflows/ci.yml

- name: Clean repository
  run: npx pjt

Troubleshooting

Problem: “pjt: command not found”

Solution: Check if pjt is installed globally and PATH is set correctly.

# Check installation
which pjt

# Reinstall if necessary
npm install -g pjt

Problem: Errors during cleaning

Solution: Run with verbose option to see details:

pjt --verbose

Problem: Package manager not recognized

Solution: Check if you have package.json or pnpm-lock.yaml in the root directory.

Next steps

Check the Guides for more detailed instructions on usage and configuration.