How to buy

If you want to buy CatLight for another company, use the following instructions. You will need a credit card to complete the purchase.

1. Go to https://catlight.io/editions and click "Buy CatLight". You will be forwarded to the account creation page.
2. Create an account: provide and confirm your email.
3. Buy the subscription using a credit card. 
4. Assign a subscription to the customer.
   • Ask the customer if they already have a team in CatLight (most customers already do). They should provide you the email of the person who is on the CatLight team that will receive the subscription.
   • Go to the

The new dashboard is split into two groups - the action list and the watch list. The action list shows alerts and action items that are sorted by priority, so you can handle them from top to bottom. It includes broken build and release pipelines, incoming pull requests, and work items. You can define your own priority rules in settings. The action list will not show any items that are in a good state and don't need your attention. Use a watch list to keep track of things that you care about, but which are not actionable at the moment. By default, it includes

Usually, when connecting to GitHub, you can use an option to "Sign in online", and CatLight will request all necessary permissions. 

If you are connecting to GitHub Enterprise, or online sign-in does not work for you, use a token to authenticate.

To get a token from GitHub, open the token page:

1. Go to GitHub
2. Click on your profile, then on "Settings"
3. Go to the "Developer settings" tab
4. Click on "Personal access tokens", then "Tokens (classic)"
5. Click on Generate new token
6. Set expiration to "No expiration" to ensure that the token works indefinitely. You specify another value if needed.
7. Select the

CatLight v3 has a lot of improvements:

• Re-designed dashboards with action and watch lists
• Create multiple dashboards and share them with your team
• New integrations. You can now monitor the following:
  • GitHub actions, issues, and pull requests
  • Jira issues
  • GitLab merge requests
• Accelerated notifications for Azure DevOps and TFS - get notified faster and reduce the server load
• You can now tell the team that you are reviewing a PR or working on a task in one click
• Improved toast notifications
• The tray icon will now show the severity of the top item on the action list

CatLight is a desktop application. Most features work locally, and data is retrieved and processed on the computer that runs the app.

There are several collaboration features that require internet access and that interact with a secure CatLight cloud service over an encrypted channel:

• Shared dashboards. When you share a dashboard in the app, the dashboard settings are saved in a CatLight cloud service, so that other users on your team can use it. Dashboard settings include the names and ids of the builds, projects and work item queries, as well as priority rules that you have configured in dashboard

CatLight uses Jira API to get the list of filters. According to Jira API docs, only the following filters will be displayed:

• filters owned by the user.
• filters shared with a group that the user is a member of.
• filters shared with a private project that the user has Browse projects project permission for.
• filters shared with a public project.
• filters shared with the public.

If you don't see any Jira filters in CatLight monitoring settings, try saving a new filter in Jira. You will be its owner, and it should be displayed afterward.

CatLight notifier works with the following servers:

• TFS 2022+, 2020, 2019, 2017, 2015, 2013. Azure DevOps Server. Work item monitoring is available only for TFS 2015+
• Azure DevOps / VSTS
• Jenkins 1.644 (released in early 2016) and newer. Jenkins 2.x is also supported
• TeamCity 8 and newer
• Travis CI (open source and pro). For enterprise - vote on this idea.
• Appveyor (open source, pro and premium)
• GitLab
• GitHub Enterprise and public GitHub
• Jira (on-prem and cloud version)

You can also create an extension for your favorite server using this open protocol, and CatLight will work with it too.

This article applies to CatLight V3. Before configuring the settings, you can learn more about how Action Center works in CatLight V3.

On the dashboard, click on settings on any of the panels to configure item groups and priority rules.

Action list settings

Use the item groups section, to select specific things that you want to monitor (build and release pipelines, pull requests for repositories, work items). Then you can create priority rules that will apply additional filters to the item group. The dashboard panel will display items that match the rules.

Priority rule settings:

• Item group dropdown - this

In Azure DevOps/TFS web ui, click on your user picture in top right -> Security -> Personal access tokens -> New Token.

• In the organization dropdown, select "All accessible organizations"
• Either provide a "full access" scope, or more granular access that should include:
  • Build - Read and execute
  • Code - Read, Status (for getting pull requests)
  • Graph - Read
  • Identity - Read
  • Project and Team - Read
  • Release - Read
  • Test management - Read
  • User Profile - Read
  • Work Items - Read and Write
• You can set a long expiration time to avoid repeating this process frequently (e.g. 1 year)

In

CatLight Protocol 1.0 is an open standard for continuous delivery servers. The CatLight app can now connect to any server that implements this protocol.

The new protocol is a replacement for the obsolete cc.xml format that was created over a decade ago, and no longer meets the feature set of modern build systems.

CatLight protocol has native support for branches, folders, consistent build history, authentication, caching and selective loading. It provides enough information for CatLight app features like build investigations, automatic branch tracking and personalized build dashboard.

We invite developers of continuous delivery servers to implement this protocol to get an amazing

Sometimes you might need to change the team that you are currently on. For example, if your current team does not have an active subscription, and you want to join the one that has.

To change the team:

1. In the CatLight app, click on the "Team" button, then on "Leave team".
2. Click on "Enable collaboration" button on the dashboard and select the new team to join. If you don't see the right team on the list, ask the team admin to add you to the team at https://service.catlight.io 

Our support team might need extended application logs to troubleshoot complex issues.

Here is how you can collect them:

1. Go to edit menu/settings/advanced and check "Enable extended logging". This will turn on the logging of requests and responses from the server. Sensitive data will be masked.
2. Repeat the action you had trouble with (e.g. connecting to a new server).
3. Click on "Help & feedback" menu -> Send diagnostic report to support

See also:  information about CatLight log files.

CatLight shows a status icon in the tray on Windows and the menu bar on Mac OS X.

When your attention is needed, CatLight will show a solid icon    . The icon will match the color of the top item on the action list.

When something is broken, but you don't need to check it, the icon will change to an outline    . This happens when all items on the dashboard are being investigated or acknowledged.

When everything is good, the icon is green 

When focus mode is activated, CatLight will stop showing you notifications, and the icon will turn to .

Windows 11 introduced "Focus assist" feature that can hide notifications from apps.

If you don't get any toast notifications from CatLight, try disabling it by searching for "Focus assist" in the Windows search menu, and then turning it off.

If you have "Priority only" option selected, you can click on "Customize priority list", and add CatLight app to it.

When a build is broken, all team members will see a button inviting them to investigate the build and fix it.

When the build is being investigated, the tray icon will change to its acknowledged state for the whole team.

  =>  

Build investigation status is displayed on the dashboard.

After the build is fixed, the investigation will be automatically removed.

Build investigations expire in 24 hours. So, if someone pressed the button and forgot about it, CatLight will raise an alarm on the next day.

This feature is available for all continuous integration servers that we support. User need

Some users experience authorization/authentication problems when they try to connect to Azure DevOps from CatLight. They can get an error message "Unauthorized" or 302 HTTP code.

This usually happens when the user has multiple Microsoft accounts(e.g. personal and work accounts), and the wrong account gets used during connection.

CatLight uses the default web browser to authenticate to Azure DevOps. This browser can have a different Microsoft account authenticated in it. For example, you use Chrome in day-to-day work and sign in using a work account there. But, the default browser is Internet Explorer or Safari, and it might have your

CatLight works with GIT branches. It will show a separate build history for each branch and pull request.

 We divide branches in four categories:

• Primary - they will be always visible on the dashboard. They include branches like master, develop, trunk, etc.
• Short-lived - those are branches for pull requests. CatLight will show them for one day on the dashboard.
• Other - this is a category for feature, bugfix and release branches. They will be tracked while they are active, and had at least one build in the past week.
• Ignored - those branches will not be monitored. You can

If you experience problems with starting the application, you can reset it by deleting configuration files. This will remove all your CatLight settings and preferences, and will revert the app to the factory state. Before deleting the configuration files, exit the app.

Location of configuration files on different platforms

Windows:

Mac OS:

Linux: 

If you have a problem with the app, you can inspect the application logs. They will often provide a detailed description of the problem and can also point to the specific project or build that is causing trouble.

Logs are written in two groups of files: 

• Log.txt – this is the log file of the background process that contains most of the app logic. It is usually the most useful, so check it first.
• TrayLog.txt – this is a log file of the UI process. If the application does not start, this log can contain details about the problem.
• NetworkLog.txt - trace of HTTP

CatLight app can monitor release definition status in TFS and VSTS/Azure Devops.

Features:

• Notifications about the status of every release environment
• Separate notification when release is waiting for your approval
• Overall status and history on the dashboard
• Release investigations