---
title: Swimlane Support Bundle Analyzer — Customer Guide
slug: turbine-user-guide/swimlane-support-bundle-analyzer-customer-guide
createdAt: 2026-10-28T12:23:54.566Z
---

**Version:** 1.0.0-beta1

**Distribution:** swimlane-support-tool (zip download)
**Audience:** On-premises customers

***

## 1. Purpose

The Swimlane Support Bundle Analyzer accelerates review of **on-prem Kubernetes support bundles**. It combines:

1. **Rules and workload skills** — structured triage guidance aligned with Swimlane support practices.
2. `swimlane-analyze` — a local command that evaluates your bundle against the same rules and writes ticket-ready outputs.

The tool is intended to **complement** Swimlane Support: you gain a consistent first pass; Support continues full investigation with your bundle and environment context.

The file can be downloaded from below.

::File{src="https://api.archbee.com/api/presign/n8uUzk0MM4uC57-zlHNtY/V9_GEV8uRSNHMImnva2ol_swimlane-support-tools-100-beta1.zip" label="swimlane-support-tools-1.0.0-beta.1.zip"}

***

## 2. What you receive

| Component                             | Description                                       |
| ------------------------------------- | ------------------------------------------------- |
| `knowledge/rules/`                    | YAML definitions for all bundle checks            |
| `kits/cursor/.cursor/`                | Rules and skills for Cursor (copy to `.cursor/`)  |
| `AGENTS.md`, `CLAUDE.md`, `GEMINI.md` | Instructions for other coding assistants          |
| `swimlane-analyze`                    | CLI that produces `report.md` and `snapshot.json` |
| `docs/`                               | Setup, troubleshooting, privacy, and this guide   |

After each run, `report.md` and `snapshot.json` are written **inside your extracted bundle folder**.

***

## 3. Requirements

- Python **3.11+**
- Unzipped package from the Freshdesk article
- Extracted support bundle directory (not a compressed archive path)
- macOS, Linux, or Windows

***

## 4. Installation (once per machine)

```bash
cd /path/to/swimlane-support-tools
python3 -m venv .venv
source .venv/bin/activate          # Windows: see docs/SETUP.md
pip install -e .
swimlane-analyze --version
```

### AI assistant and rules kit (recommended)

**Cursor:**

```bash
cp -R kits/cursor/.cursor .cursor
```

Open the project in Cursor; start with the **navigation** skill under `.cursor/skills/navigation/`.

**Other assistants:** Open the folder and follow `CLAUDE.md`, `GEMINI.md`, or `AGENTS.md`.

Further detail: `docs/AI-ASSISTANT-GUIDE.md` and `docs/WHAT-THIS-TOOL-DOES.md` in the package.

***

## 5. Prepare the support bundle

Extract the archive your cluster or Replicated tooling produced.

| Archive type | Typical steps                                         |
| ------------ | ----------------------------------------------------- |
| `.tar.gz`    | `tar -xzf supportbundle-….tar.gz`                     |
| `.tar.7z`    | Extract with 7-Zip, then `tar -xzf` the inner tarball |

Point the analyzer at the folder that contains `cluster-resources/`, `turbine/`, and `kots/`.

***

## 6. Run analysis

```bash
cd /path/to/swimlane-support-tools
source .venv/bin/activate
swimlane-analyze --bundle "/path/to/extracted/support-bundle"
```

Optional:

```bash
swimlane-analyze --bundle "/path/to/bundle" --symptom "Describe the issue for Support"
```

### With a coding assistant

1. Follow the navigation and workload skills.
2. Run `swimlane-analyze` (you or the assistant).
3. Discuss `report.md` using the skills; do not rely on findings that are not in the report.

***

## 7. Submit results to Support

Attach to your Freshdesk ticket:

- `report.md` (required for best experience)
- `snapshot.json` (optional)
- `swimlane-analyze --version`
- Bundle collection time and symptom description

***

## 8. Privacy and security

- Analysis is **local**; the CLI does not call cloud APIs.
- Redaction is applied to common secret patterns in outputs; review before sharing.
- Do not store production credentials in the tool folder.
- AI assistants are optional and governed by your organization’s policies.

See `docs/PRIVACY.md` in the package.

***

## 9. Troubleshooting

| Issue                                 | Action                                                 |
| ------------------------------------- | ------------------------------------------------------ |
| `command not found: swimlane-analyze` | Activate `.venv` or use `./.venv/bin/swimlane-analyze` |
| Bundle path must be a directory       | Extract the archive first                              |
| Empty or unexpected findings          | Confirm bundle layout; see `docs/TROUBLESHOOTING.md`   |

***

## 10. Updates

Download the new zip from the Freshdesk article when Swimlane announces an update, then:

```bash
pip install -e . --force-reinstall
swimlane-analyze --version
```

***

## 11. Terms

Use of this package is limited to supporting your Swimlane deployment. Redistribution of the zip or contents requires Swimlane’s permission. See the Freshdesk article for the current terms statement.

***

## 12. Related documents in the package

| Document                      | Topic                         |
| ----------------------------- | ----------------------------- |
| `README.md`                   | Quick orientation             |
| `docs/SETUP.md`               | Commands and platform notes   |
| `docs/AI-ASSISTANT-GUIDE.md`  | Cursor, Claude, Gemini, Codex |
| `docs/WHAT-THIS-TOOL-DOES.md` | Rules, skills, and CLI        |
| `docs/TROUBLESHOOTING.md`     | Common errors                 |
| `docs/PRIVACY.md`             | Data handling                 |
| `docs/VERSIONING.md`          | Version and updates           |