# stack-auditor

**Repository Path**: mirrors_cloudfoundry/stack-auditor

## Basic Information

- **Project Name**: stack-auditor
- **Description**: Stack Auditor is a cf CLI plugin that provides commands for listing apps and their stacks, migrating apps to a new stack, and deleting a stack.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Stack Auditor

![Stack Auditor Logo](logo.png "Stack Auditor Logo")

## Installation

* Download the latest stack-auditor from the [release section](https://github.com/cloudfoundry/stack-auditor/releases) of this repository for your operating system. 
* Install the plugin with `cf install-plugin <path_to_binary>`.

### Alternative: Compile from source

Prerequisite: Have a working golang environment with correctly set
`GOPATH`.

```sh
go get github.com/cloudfoundry/stack-auditor
cd $GOPATH/src/github.com/cloudfoundry/stack-auditor
./scripts/build.sh

```

## Usage

Install the plugin with `cf install-plugin <path_to_binary>` or use the shell scripts `./scripts/install.sh` or `./scripts/reinstall.sh`.

* Audit cf applications using `cf audit-stack [--csv | --json]`. These optional flags return csv or json format instead of plain text.
* Change stack association using `cf change-stack <app> <stack>`. This will attempt to perform a zero downtime restart. Make sure to target the space that contains the app you want to re-associate. 
* Delete a stack using `cf delete-stack <stack> [--force | -f]`

## Run the Tests

Target a cloudfoundry with the following prerequisites:
  - has cflinuxfs3 and cflinuxfs4 stacks and buildpacks
    - If using cf-deployment, this can be enabled with the ops file `operations/experimental/add-cflinuxfs4.yml`
  - you are targeting an org and a space

Then run:

`./scripts/all-tests.sh`