Installation Guide

Learn how to install Showel AI Insights in your Jira Cloud workspace.

Prerequisites

Before installing Showel, ensure you have:

• Jira Cloud administrator access - Required to install apps from the Atlassian Marketplace
• A Cursor AI account - With API access enabled
• Active Cursor team subscription - For team-wide token tracking

Installation Steps

1. Access the Atlassian Marketplace

Navigate to Showel AI Insights on the Atlassian Marketplace.

2. Install the App

1. Click the Try it free or Get it now button
2. Select your Jira site from the dropdown
3. Review the permissions required:
   • Read and write Jira issue data
   • Access external APIs (Cursor API)
   • Store configuration data
4. Click Install to confirm

The installation process typically takes 30-60 seconds.

3. Configure API Access

After installation, you'll need to connect your Cursor account:

1. Navigate to Settings > Apps > Showel
2. You'll see the Showel admin page with sidebar navigation
3. Click on API Configuration in the sidebar (this is the default view)
4. Enter your Cursor API credentials:
   • API Key: Your Cursor Admin API key
   • Account ID: Your Cursor team account ID
5. Click Save Configuration and then Test Connection to verify

Showel Admin Page The Showel admin page with sub-navigation in the sidebar

API Configuration Form API Configuration page showing the Cursor API setup form

Where to find your Cursor API key:

1. Log in to your Cursor account
2. Go to Settings > API Keys
3. Generate a new Admin API key
4. Copy the key (you won't be able to see it again)

3.5. Configure Project Visibility (Optional)

Control which Jira projects can access Showel reports:

1. In the Showel admin page, click Project Visibility in the sidebar
2. You'll see a list of all your Jira projects
3. Use the toggles or bulk actions to allow/deny projects
4. Projects are denied by default (opt-in security model)

Project Visibility Configuration Project Visibility page showing access controls for each Jira project

Note: Only allowed projects will see Token Usage Reports and AI Adoption Analytics. This ensures data is only visible to authorized teams.

4. Verify Installation

To confirm Showel is installed correctly:

1. Navigate to Settings > Apps > Showel to verify the admin pages load
2. Go to any allowed Jira project and check:
   • Token Usage Report in the project sidebar
   • AI Adoption Analytics in the project settings
3. Open any Jira issue and look for the Token Usage custom field

If you see these elements, congratulations! Showel is successfully installed and configured.

Troubleshooting

App Not Appearing

If Showel doesn't appear after installation:

• Refresh your browser (Ctrl+R or Cmd+R)
• Clear your browser cache
• Wait a few minutes and try again

API Connection Issues

If you're having trouble connecting to the Cursor API:

• Verify your API key is correct and hasn't expired
• Ensure your Cursor account has API access enabled
• Check that your account ID matches your team account

Permission Errors

If you see permission errors:

• Confirm you have Jira administrator access
• Check that all required permissions were granted during installation
• Try reinstalling the app with proper permissions

Next Steps

Now that Showel is installed:

• Quick Start Guide - Get up and running in 5 minutes
• Features Overview - Learn about all available features
• Tracking Usage - Start monitoring token consumption

Uninstalling Showel

If you need to uninstall Showel:

1. Go to Settings > Apps > Manage apps
2. Find "Showel AI Insights" in the list
3. Click Uninstall
4. Confirm the uninstallation

Note: Uninstalling will remove all custom fields and stored configuration data.