PathfindAI CLI

Seamlessly integrate task management with your git workflow. The PathfindAI CLI allows you to track tasks directly in your commit messages and sync them with your PathfindAI workspace.

🚀 Installation

Option 1: NPM

npm install -g pathfindai-cli

Option 2: Yarn

yarn global add pathfindai-cli

Option 3: pnpm

pnpm add -g pathfindai-cli

Option 4: Direct from GitHub

# Clone the repository
git clone https://github.com/PathfindAI/cli.git
cd cli

# Install dependencies
npm install

# Make executable and link globally
chmod +x pathfind-cli.js
npm link

Option 5: Download and Run

# Download the CLI
curl -o pathfind-cli.js https://raw.githubusercontent.com/PathfindAI/cli/main/pathfind-cli.js

# Make executable
chmod +x pathfind-cli.js

# Install dependencies (if not using global install)
npm install commander inquirer chalk axios

# Run directly
./pathfind-cli.js help

🔧 Setup

After installation, authenticate with your PathfindAI account:

pathfind auth login

The CLI will:

1. Ask for your Personal Access Token
2. Automatically fetch and confirm your email
3. Configure git integration

Environment Variables

You can configure the API endpoint using environment variables:

# For development/custom endpoints
export PATHFIND_API_URL=http://localhost:3000

Or pass it directly:

pathfind auth login --api-url http://localhost:3000

📖 Usage

Authentication Commands

pathfind auth login     # Login to PathfindAI
pathfind auth logout    # Logout from PathfindAI
pathfind status         # Show authentication status

Task Tags in Commits

Use these tags in your commit messages to update task status:

git commit -m "fix bug [done] #abc123"        # Mark task as done
git commit -m "start feature [inp] #def456"   # Mark task as in progress  
git commit -m "todo item [td] #ghi789"        # Mark task as todo
git commit -m "add to backlog [bk] #jkl012"   # Mark task as backlog

Help

pathfind help           # Show available commands

🔑 Getting Your Personal Access Token

1. Log into your PathfindAI account
2. Go to Settings → API Keys
3. Generate a new Personal Access Token
4. Copy the token (starts with pat_)

🛠️ Requirements

• Node.js 16.0.0 or higher
• Git (for commit integration)
• PathfindAI account with Personal Access Token

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

📝 License

MIT License - see LICENSE file for details

🐛 Issues

Report bugs and feature requests at: https://github.com/PathfindAI/cli/issues