Skip to content

Expand README to document all tools in tap #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Expand README to document all tools in tap #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
185594e
Initial plan
Copilot Feb 17, 2026
399d446
Improve README with comprehensive documentation
Copilot Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
260 changes: 217 additions & 43 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,78 +1,252 @@
# StackGen Homebrew Installation
# StackGen Homebrew Tap

This guide will walk you through the steps to install `stackgen` using Homebrew.
This is the official [Homebrew](https://brew.sh/) tap for [StackGen](https://stackgen.com/) tools. StackGen provides a suite of infrastructure-as-code tools for cloud infrastructure management, observability, and automation.

## Available Tools

This tap provides the following tools:

| Tool | Description |
|------|-------------|
| **stackgen** | Generative Infrastructure from Code - Main CLI for infrastructure management |
| **cloud2code** | Convert your cloud resources to Terraform state files |
| **genie** | AI-powered infrastructure generation assistant |
| **logexplorer** | Advanced log exploration and analysis tool |
| **stackgen-slo** | Service Level Objectives (SLO) management tool |
| **terraform-importer** | Parse and import Terraform IaC files into StackGen |
| **stackboot** | Bootstrap tool for StackGen projects |

## Prerequisites

Before you begin, make sure you have the following:
Before you begin, make sure you have:

- An account at <https://cloud.stackgen.com/>
- Homebrew installed on your system. If you don't have Homebrew installed, you can install it by running the following command in your terminal:
- **Homebrew** installed on your system. If you don't have Homebrew, install it with:
```shell
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

```shell
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
- An account at <https://cloud.stackgen.com/> (or your organization's StackGen instance)

## Installation

Follow these steps to install `stackgen` using Homebrew:
### Installing Individual Tools

You can install any tool directly without adding the tap first:

1. Open your terminal.
```shell
# Install the main StackGen CLI
brew install stackgenhq/stackgen/stackgen

2. Run the following command to add the stackgen tap:
# Install cloud2code
brew install stackgenhq/stackgen/cloud2code

```shell
brew install stackgenhq/homebrew-stackgen/stackgen
```
# Install genie
brew install stackgenhq/stackgen/genie

3. After the installation is complete, you can verify the installation by running the following command:
# Install logexplorer
brew install stackgenhq/stackgen/logexplorer

```shell
stackgen version
```
# Install stackgen-slo
brew install stackgenhq/stackgen/stackgen-slo

This should display the version of `stackgen` installed on your system.
# Install terraform-importer
brew install stackgenhq/stackgen/terraform-importer

## Configuring
# Install stackboot
brew install stackgenhq/stackgen/stackboot
```

### Using our cloud service
### Installing Multiple Tools

To configure `stackgen`, you need to set your API key. Follow these steps:
If you plan to install multiple tools, you can add the tap first:

1. Log in to your account at <https://cloud.stackgen.com/>.
```shell
# Add the tap
brew tap stackgenhq/stackgen

2. Navigate to your [personal access token settings](https://cloud.stackgen.com/account-settings/pat/).
# Install tools (without needing the full path)
brew install stackgen
brew install cloud2code
brew install genie
```

3. Copy your API key.
### Verifying Installation

4. Run the following command in your terminal to set the API key:
After installation, verify that the tool is installed correctly:

```shell
export STACKGEN_TOKEN=<YOUR_API_KEY>
```
```shell
stackgen version
```

Replace `<YOUR_API_KEY>` with your actual API key.
This should display the version of the installed tool.

### Using on-premises installation
## Configuration

```sh
export STACKGEN_URL="https://stackgen.<acme.org>"
```
### Cloud Service (cloud.stackgen.com)

To use StackGen tools with the cloud service:

1. Log in to your account at <https://cloud.stackgen.com/>

2. Navigate to your [personal access token settings](https://cloud.stackgen.com/account-settings/pat/)

3. Copy your personal access token (API key)

4. Set the token as an environment variable:

```shell
export STACKGEN_TOKEN=<YOUR_API_KEY>
```

Replace `<YOUR_API_KEY>` with your actual token.

1. Log in to your account at <https://stackgen.acme.org/>.
5. (Optional) Add it to your shell profile to persist across sessions:

2. Navigate to your personal access token settings @ <https://stackgen.acme.org/account-settings/pat/>.
```shell
# For bash
echo 'export STACKGEN_TOKEN=<YOUR_API_KEY>' >> ~/.bashrc

# For zsh
echo 'export STACKGEN_TOKEN=<YOUR_API_KEY>' >> ~/.zshrc
```

3. Copy your API key.
### On-Premises Installation

4. Run the following command in your terminal to set the API key:
If your organization uses a self-hosted StackGen instance:

```shell
export STACKGEN_TOKEN=<YOUR_API_KEY>
```
1. Set the StackGen URL environment variable:

Replace `<YOUR_API_KEY>` with your actual API key.
```shell
export STACKGEN_URL="https://stackgen.<your-domain.com>"
```

2. Log in to your instance at `https://stackgen.<your-domain.com>/`

3. Navigate to your personal access token settings at `https://stackgen.<your-domain.com>/account-settings/pat/`

4. Copy your personal access token

5. Set the token as an environment variable:

```shell
export STACKGEN_TOKEN=<YOUR_API_KEY>
```

6. (Optional) Add both variables to your shell profile for persistence:

```shell
echo 'export STACKGEN_URL="https://stackgen.<your-domain.com>"' >> ~/.bashrc
echo 'export STACKGEN_TOKEN=<YOUR_API_KEY>' >> ~/.bashrc
```

## Usage

You can now start using `stackgen`. Run the following command to see the available commands:
Once installed and configured, you can start using the StackGen tools:

```shell
# View available StackGen CLI commands
stackgen --help

# Check version
stackgen version

# Cloud2Code - Import cloud resources to Terraform
cloud2code --help

# Genie - AI-powered infrastructure generation
genie --help

# Log Explorer - Analyze logs
logexplorer --help

# StackGen SLO - Manage service level objectives
stackgen-slo --help

# Terraform Importer - Import Terraform files
terraform-importer --help
```

For detailed documentation on each tool, visit the [StackGen Documentation](https://docs.stackgen.com/).

## Updating

To update any installed tool to the latest version:

```shell
# Update Homebrew and upgrade the tool
brew update
brew upgrade stackgen

# Or upgrade all StackGen tools at once
brew upgrade stackgenhq/stackgen
```

## Uninstalling

To remove any installed tool:

```shell
# Uninstall a specific tool
brew uninstall stackgen

# Remove the tap (after uninstalling all tools)
brew untap stackgenhq/stackgen
```

## Troubleshooting

### Command not found after installation

If you get a "command not found" error after installation:

1. Make sure Homebrew's bin directory is in your PATH:
```shell
echo $PATH
```

2. If needed, add Homebrew to your PATH:
```shell
# For Apple Silicon Macs
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zshrc

# For Intel Macs
echo 'eval "$(/usr/local/bin/brew shellenv)"' >> ~/.zshrc
```

3. Restart your terminal or run:
```shell
source ~/.zshrc
```

### Authentication issues

If you're having trouble authenticating:

1. Verify your token is set correctly:
```shell
echo $STACKGEN_TOKEN
```

2. Make sure you have the correct permissions in your StackGen account

3. For on-premises installations, verify the `STACKGEN_URL` is set correctly

### Getting help

- Check the [StackGen Documentation](https://docs.stackgen.com/)
- Visit the [StackGen Community](https://community.stackgen.com/)
- Report issues on [GitHub](https://github.com/stackgenhq/homebrew-stackgen/issues)
- Contact support at <support@stackgen.com>

## Contributing

This tap is automatically updated by the StackGen release process. If you encounter any issues, please [open an issue](https://github.com/stackgenhq/homebrew-stackgen/issues/new).

## License

Individual tools have their own licenses. See the formula files for details:
- Most tools are licensed under Apache License 2.0
- Some tools (cloud2code, terraform-importer) are proprietary

For more information, visit <https://stackgen.com/>