Jira Dashboard

View and manage your Jira tickets from a simple dashboard — no need to navigate Jira itself.

Before You Begin

You'll need three things set up before you can use the dashboard. This only takes about 5 minutes.

1. Node.js (a behind-the-scenes engine)

The dashboard needs Node.js installed on your computer to run. You don't need to know what it does — just think of it as a required engine.

Check if you already have it:

1. Open Terminal (Mac) or Command Prompt (Windows)
   • Mac: Press Cmd + Space, type Terminal, hit Enter
   • Windows: Press Win + R, type cmd, hit Enter
2. Type node --version and press Enter
3. If you see something like v18.0.0 or higher, you're all set ✅

If you don't have it:

1. Go to nodejs.org
2. Click the big "LTS" download button (LTS = most stable version)
3. Install it like any other program
4. Close and reopen your Terminal window before continuing

2. A Jira API Token (your secure password for the app)

Instead of using your Jira password directly, you'll create a special token just for this app. It's safer and easy to remove if needed.

How to create one:

1. Go to Atlassian API Token page
2. Click "Create API token"
3. Give it any name — for example, Jira Dashboard
4. Click "Create", then copy the token that appears
5. Paste it somewhere safe (like a note on your computer) — you'll need it in the next section and won't be able to see it again

3. Your Jira URL

This is the web address you normally type to get to Jira at work. It usually looks like one of these:

• https://yourcompany.atlassian.net
• https://jira.yourcompany.com

Setup & Launch

Step 1 — Run the one-time setup

Open Terminal (or Command Prompt) and paste this, then press Enter:

npx jira-pat config

It will ask you for three things:

• Jira URL — the address from Step 3 above
• Email — the email you use to log into Jira
• API Token — the token you created in Step 2

🔒 Your details are saved only on your computer and are never sent anywhere else.

Where your details are saved (for your reference):

• Mac/Linux: ~/.jira-dashboard-config.json
• Windows: C:\Users\YourName\.jira-dashboard-config.json

Step 2 — Start the dashboard

Each time you want to use the dashboard, run:

npx jira-pat

Your browser should open automatically. If it doesn't, open your browser and go to:

http://localhost:5173

Using the Dashboard

Finding your tickets

• When you open the dashboard, you'll see all tickets currently assigned to you.
• Use the search bar at the top to look up a ticket by keyword. Tip: press / on your keyboard to jump straight to it.
• Use the Project and Status dropdowns to filter the list down to what you need.

Viewing and updating a ticket

• Click any row to open a side panel with the full details.
• Change the status by clicking the status label (e.g. In Progress, Done).
• Reassign a ticket by clicking the assignee's name and searching for someone else.
• Attach a file by dragging and dropping it onto the side panel.

Creating a new ticket

1. Click the blue + button in the top-right corner.
2. Choose a Project and Issue Type (Task, Bug, Story, etc.).
3. Write a short Summary and click Create.

Something Not Working?

| What you're seeing | What to try | |--------------------|-------------| | "command not found" | Node.js isn't installed — go back to Step 1 | | "Cannot connect to Jira" | Check your Jira URL, email, and API token — run npx jira-pat config again | | "Port already in use" | Close other apps or browser tabs that might be using ports 5000 or 5173 | | Browser doesn't open | Manually go to http://localhost:5173 in your browser |

Features

Dashboard & Search

• View all Jira tickets assigned to you
• Search tickets by keyword, issue key, or summary
• Filter by project and status
• Keyboard shortcut / to quickly access search

Issue Management

• View full issue details in a side panel
• Update issue status (transitions)
• Reassign issues to other users
• Add and remove labels
• Update fix versions
• Upload attachments (drag & drop)
• Edit issue summary — click the pencil icon next to the title
• Edit issue description — click the pencil icon next to the description header

Project Management

• Create new issues (Task, Bug, Story, Epic, etc.)
• View available projects
• Browse project versions/releases

Comments

• View and add comments on issues
• Edit your own comments
• @mention team members — type @ in the comment box to search and mention project members

Real-time Updates

• Optimistic UI updates for faster feedback
• Loading states and error handling
• Toast notifications for actions

License

ISC