Pal - Git Workflow Helper

Pal is a command-line tool that enhances your Git workflow with smart branch naming and Linear integration.

Features

• Smart Branch Naming: Automatically creates branch names with your username
• Linear Integration: Link and create Linear issues directly from the command line
• Pull Request Integration: Create PRs with Linear issue references

Installation

# Clone the repository
git clone [email protected]:Palo-Inc/palcmd.git
cd palcmd

# Install dependencies
npm install

# Install globally (optional)
npm install -g .

Usage

Configuration

Before using Pal, you should configure it:

pal config

This will prompt you for:

• Your username (for branch naming)
• Optional branch prefix
• Linear API key (if you want Linear integration)
• Default Linear team (if Linear integration is enabled)

Creating a Feature Branch

Create a new feature branch with smart naming:

# Interactive mode
pal feature

# Direct mode with feature name
pal feature "add new button"

The branch name will be created with the following pattern: {prefix}/{linear-issue-key}/{username}/{feature-name}

For example: feature/eng-123/john/add-new-button

Creating a Pull Request

Create a pull request linked to Linear:

pal pr

This will:

1. Detect Linear issue keys in your branch name
2. Allow you to create or link to Linear issues
3. Push your branch to remote (if requested)
4. Generate a URL for creating the PR

Viewing Branch Information

View information about your current branch and its associated Linear issue:

pal info

This will display:

• Current branch name
• Branch prefix
• Linear issue key (if any)
• Linear issue details (title, status, assignee, URL)
• Quick link to create a PR

Linear Integration

Pal integrates with Linear to:

• Create Linear issues from the command line
• Link branches and PRs to Linear issues
• Auto-populate PR titles and descriptions with Linear issue information

To use Linear integration, you need a Linear API key which you can generate in your Linear account settings.