Set up GUIJam for Jira
Install the Jira app#
A Jira site admin opens the GUIJam for Jira installation link, chooses the site, for example yourteam.atlassian.net, and installs it. The app asks for:
| Permission | Why |
|---|---|
| Read and write Jira work | Read tickets and their images; post comments, screenshots and status moves; create reported tickets. |
| Read users and permissions | Show who applied a change, and check each person's own Jira permissions before every read and write. |
| App storage | Keep pairing records (as hashes), results and rate limits inside Jira. |
Images from *.atlassian.net | Show the ticket's own before and after screenshots in the GUIJam panel. |
Create a Jira space#
Jira now calls projects Spaces. Use a software space, since UI tickets belong next to development work.
- Open Jira, not Confluence: use the grid icon at the top left, or go to
yourteam.atlassian.net/jira. - In the sidebar, hover Spaces and click +. Choose Software development, then Kanban, then a team-managed space.
- Name it, for example Web, and set the key to
WEB. Ticket keys start with it:WEB-1,WEB-2.
A brand-new space can say you don't have permission to create work in it for a minute. Wait, refresh, and use work type Task.
Create a frontend project#
Skip this if you already have an app. Otherwise, start one with your framework's own starter:
| Framework | Command |
|---|---|
| React + Vite | npm create vite@latest my-shop -- --template react-ts |
| Vue + Vite | npm create vite@latest my-shop -- --template vue-ts |
| Solid + Vite | npm create vite@latest my-shop -- --template solid-ts |
| SvelteKit | npx sv create my-shop |
| Astro | npm create astro@latest my-shop |
| Next.js | npx create-next-app@latest my-shop |
| Nuxt | npx nuxi@latest init my-shop |
| React Router | npx create-react-router@latest my-shop |
cd my-shop
npm installInstall GUIJam and connect Jira#
In your app's folder:
$ npx guijam@latest init$ pnpm dlx guijam@latest init$ yarn dlx guijam@latest init$ bunx guijam@latest initinit detects your framework, adds guijam, wires your config and helps you pick an AI coding CLI. Its last step is optional:
Link UI tickets to your changes: GUIJam posts before/after screenshots and the diff to the ticket.
? Connect Jira? No / YesChoose Yes and it asks for a pairing code. Get one from Jira:
- Create any ticket with + Create, work type Task, and open it.
- Under the ticket's title, click the GUIJam button. If it isn't there, look under Apps or ••• in that row.
- If Jira asks, click Allow access. The app reads which projects you can use, as you.
- In the GUIJam panel, click Pair GUIJam. A green box shows a command with a code that starts with
gjp_. It's shown once. - Paste the code into
init, or run the command in your app's folder:
npx guijam jira pair gjp_eyJ2IjoxLCJ1cmwiOi...Paired with yourteam.atlassian.net as Ana Cruz. GUIJam can now link your changes to Jira tickets.Check the connection#
npx guijam jira status # the paired sites
npx guijam jira test # Connected to yourteam.atlassian.net as Ana Cruz. 3 open tickets are assigned to you.
npx guijam doctor # the whole setup, including JiraThen start your dev server as usual and open the app. The GUIJam toolbar sits at the bottom right.
Next: Work Jira tickets in GUIJam.