CLI Interface

pjt CLI is designed to be easy to use with powerful options for advanced users.

Basic syntax

pjt [options]

Options

—help, -h

Show help and all available options.

pjt --help

—version, -v

Show pjt version.

pjt --version

—verbose, -V

Enable verbose mode for more detailed output.

pjt --verbose

—clean-only

Clean repository without reinstalling dependencies.

pjt --clean-only

—dry-run

Simulate operations without actual changes.

pjt --dry-run

Usage examples

Standard cleaning

cd /path/to/your/repo
pjt

Cleaning with details

pjt --verbose

Output:

🔍 Detected package manager: pnpm
🗂️ Found 5 empty directories
🗂️ Removed: empty-folder/
🗂️ Removed: another-empty/
...
🚫 Found 12 ignored files
🚫 Removed: node_modules/.cache/file.js
...
📦 Cleaning node_modules...
📦 Reinstalling dependencies...
✅ Done!

Clean only

pjt --clean-only

Use when you want to clean without reinstallation.

Registry system

pjt uses a registry system to manage configurations. Registry files are located in src/bin/registry.ts.

Registry structure

export const registries = {
  eslint: {
    name: 'ESLint',
    configs: ['recommended', 'strict', 'minimal']
  },
  prettier: {
    name: 'Prettier',
    configs: ['default', 'custom']
  }
};

Error handling

CLI has robust error handling:

Validation errors: Invalid options or parameters
File system errors: Problems accessing files
Git errors: Problems with Git repository
Package manager errors: Errors during installation

All errors are logged with clear messages and suggestions for resolution.

Exit codes

0: Success
1: General error
2: Invalid options
3: Git repository not found

Integration with other tools

In npm scripts

Add to package.json:

{
  "scripts": {
    "clean": "pjt --clean-only",
    "fresh": "pjt"
  }
}

In Git hooks

Use with Husky for automatic cleaning pre-commit:

pjt --clean-only

Troubleshooting

”Command not found”

# Check PATH
echo $PATH

# Reinstall
npm install -g pjt

Permission denied

# On Linux/Mac
sudo pjt

# Or change permissions
chmod +x $(which pjt)

Git repository not found

# Initialize Git repo
git init

# Or navigate to existing
cd /path/to/git/repo