Documentation
Go back

Quick Start Guide

Get started with Ticket-Mate CLI commands in 5 minutes.

Installation

bash
npm install -g @ameshkin/ticket-mate
# or
npx @ameshkin/ticket-mate

Configuration

Set environment variables:

bash
export ATLASSIAN_BASE_URL="https://pamcms.atlassian.net"
export ATLASSIAN_EMAIL="your-email@example.com"
export ATLASSIAN_API_KEY="your-api-token"
export ATLASSIAN_PROJECT_KEY="NOVA"

Or create .env file:

env
ATLASSIAN_BASE_URL=https://pamcms.atlassian.net
ATLASSIAN_EMAIL=your-email@example.com
ATLASSIAN_API_KEY=your-api-token
ATLASSIAN_PROJECT_KEY=NOVA

Essential Commands

1. Test Your Setup

bash
tm config-test

2. Setup Cursor Board

bash
tm setup-board -p NOVA

3. Create a Ticket

bash
tm create -p NOVA -t "My first ticket" -u cursor.automation

4. View Your Tickets

bash
tm my-tickets

5. Check What Worked

bash
tm report --failures

Common Workflows

Daily Workflow

bash
# 1. Check your tickets
tm my-tickets

# 2. Create new ticket for cursor
tm create -p NOVA -t "Task name" -u cursor.automation

# 3. Check if it worked
tm report --failures

Assign Existing Ticket to Cursor

bash
# Assign to cursor (triggers workflow)
tm assign-to-cursor -t NOVA-123

Move Ticket Through Workflow

bash
# Move to In Progress
tm transition -t NOVA-123 -s "In Progress"

# Move to Done
tm transition -t NOVA-123 -s "Done"

Search Tickets

bash
# Find cursor tickets
tm search -q "assignee = cursor.automation"

# Find my in-progress tickets
tm search -q "assignee = currentUser() AND status = 'In Progress'"

Command Cheat Sheet

TaskCommand
Create tickettm create -p NOVA -t "Title" -u cursor.automation
Assign to cursortm assign-to-cursor -t NOVA-123
List ticketstm ls-tickets -p NOVA
My ticketstm my-tickets
Move tickettm transition -t NOVA-123 -s "In Progress"
Add commenttm comment -t NOVA-123 -m "Comment"
Searchtm search -q "project = NOVA"
View reporttm report --failures
Test workflowtm test-workflow -p NOVA

Next Steps

Getting Help

bash
# List all commands
tm --help

# Get help for specific command
tm create --help
tm assign --help

Troubleshooting

Command Not Found

bash
# Install globally
npm install -g @ameshkin/ticket-mate

# Or use npx
npx @ameshkin/ticket-mate create -p NOVA -t "Title"

Authentication Errors

bash
# Test configuration
tm config-test

# Check environment variables
echo $ATLASSIAN_API_KEY

Workflow Not Triggering

bash
# Check API report
tm report --failures

# Test workflow
tm test-workflow -p NOVA

Related Documentation