> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/stackai-auto-cli/config/support.md).

# StackAI Support

This folder contains support-related artifacts, primarily the **sanitized support report bundle** generated by the CLI.

## Generate a Support Bundle

```bash
stackai support
```

`stackai support` is an alias of `stackai report`.

The report is generated as a tarball (for example: `stackai-report-YYYYMMDD_HHMMSS.tar.gz`) and includes:

* System information (OS, CPU, memory, disk)
* Docker status (containers, images, networks, resource usage)
* Service logs (sanitized)
* Health checks (database connectivity checks)
* Configuration snapshots (sanitized; secrets redacted)

## What support should request (best practice)

Ask customers for the following, in order:

1. `stackai support` tarball
2. `stackai version` and `stackai info` output
3. A short symptom timeline (what failed, when it started, last known good)

Avoid requesting raw secrets unless explicitly required. If needed, request masked output first:

```bash
stackai secrets
```

and only request `stackai secrets --reveal` with a clear justification.

## Contact

Email: <support@stack-ai.com>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/stackai-auto-cli/config/support.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.